Skip to content

Add CONTRIBUTING.md to Guide New Contributors #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
FMCalisto opened this issue Mar 16, 2024 · 0 comments · Fixed by #21, #25, #26, #29 or #28
Closed

Add CONTRIBUTING.md to Guide New Contributors #23

FMCalisto opened this issue Mar 16, 2024 · 0 comments · Fixed by #21, #25, #26, #29 or #28
Assignees
Labels
enhancement New feature or request

Comments

@FMCalisto
Copy link
Member

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.

@FMCalisto FMCalisto added the enhancement New feature or request label Mar 16, 2024
@FMCalisto FMCalisto self-assigned this Mar 16, 2024
@FMCalisto FMCalisto linked a pull request Mar 26, 2024 that will close this issue
@FMCalisto FMCalisto linked a pull request Aug 27, 2024 that will close this issue
@github-project-automation github-project-automation bot moved this to Done in Tasks Aug 28, 2024
@FMCalisto FMCalisto linked a pull request Sep 15, 2024 that will close this issue
@FMCalisto FMCalisto linked a pull request Oct 1, 2024 that will close this issue
This was linked to pull requests Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment