Contributing

[sirkitree]

As more folks get into contributing, we should have a guideline in place.

Here's a comprehensive guide on creating contribution guidelines for a GitHub repository:

Essential Components

Welcome Message
Create a welcoming introduction that encourages contributions and expresses gratitude to potential contributors[1].

Basic Structure
Place the CONTRIBUTING.md file in your repository's root directory or .github folder to ensure visibility[2].

Key Sections to Include

Code of Conduct
Include guidelines for community behavior and interaction standards[1][6].

Contribution Process

• Explain how to submit pull requests and bug reports[1]
• Describe the preferred branching strategy
• Outline the review process[1]

Technical Requirements

• Coding style and conventions
• Testing requirements
• Documentation standards[1]

Best Practices

Clear Communication

• Use straightforward language
• Provide step-by-step instructions
• Include examples where necessary[5]

Issue Management

• Explain how to report bugs
• Describe the process for suggesting enhancements
• Detail how to use issue labels[1]

Supporting Elements

Additional Documentation

• Link to relevant documentation
• Include setup instructions
• Provide contact information for maintainers[2]

Recognition
Create a system for acknowledging contributors' efforts and explaining how contributions will be credited[2].

Maintenance

Regular Updates
Keep the guidelines current and aligned with project needs[4].

Template Usage
Consider using GitHub's built-in templates for common contribution scenarios[6].

Citations:
[1] https://github.com/jessesquires/.github/blob/main/CONTRIBUTING.md
[2] http://mozillascience.github.io/working-open-workshop/contributing/
[3] https://github.blog/news-insights/contributing-guidelines/
[4] https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions
[5] https://gist.github.com/MarcDiethelm/7303312
[6] https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project
[7] https://opensource.creativecommons.org/contributing-code/github-repo-guidelines/
[8] https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project