Skip to content

Add CONTRIBUTING.md to Guide New Contributors #23

Closed
@FMCalisto

Description

@FMCalisto

Issue Description

The repository currently lacks a CONTRIBUTING.md file, which is crucial for guiding new contributors through the process of making contributions. This file should include guidelines on how to report issues, propose new features, set up the development environment, and submit pull requests.

Suggested Solution

Create a CONTRIBUTING.md file with the following sections:

  • Introduction: Briefly explain the purpose of the file and encourage contributions.
  • Reporting Issues: Provide guidelines on how to report bugs or request features, including the information that should be included in a report.
  • Setting Up Development Environment: Step-by-step guide on setting up the environment for development and testing changes locally.
  • Making Changes: Instructions on how to make and test changes.
  • Submitting Pull Requests: Guidelines on the process for submitting pull requests, including coding standards and review process.

Expected Outcome

A clear, comprehensive CONTRIBUTING.md file that makes it easier for new contributors to get involved and helps ensure contributions are consistent and high quality.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions