Skip to content
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

Add contributing.md to repo #275

Open
chris-bateman opened this issue Feb 28, 2024 · 0 comments · Fixed by 2pisoftware/cmfive-boilerplate#127
Open

Add contributing.md to repo #275

chris-bateman opened this issue Feb 28, 2024 · 0 comments · Fixed by 2pisoftware/cmfive-boilerplate#127
Assignees
Labels
documentation Improvements or additions to documentation question

Comments

@chris-bateman
Copy link
Member

I've been thinking about how we can make our contribution process smoother.

Why We Need a CONTRIBUTING.md

  • Efficiency: With clear guidelines, we can reduce back-and-forth on PRs and issues. And reduce setup/troubleshooting time for getting started.

What to Include

Here's what I'm thinking we could cover in the CONTRIBUTING.md:

  1. Quick Start Guide: How to fork, clone, and set up the project locally.
  2. What We're Looking For: Types of helpful contributions (bug fixes, features, docs updates, etc.).
  3. How to Submit Contributions: Steps for opening issues, creating PRs, etc.
  4. Style Guide: Coding standards, naming conventions, etc.
  5. PR Process: How we review and merge PRs, including any CI/CD stuff.

More info here - https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Next Steps

I'm happy to draft the initial version of this and get your feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants