We need to establish clear contributing guidelines to help new contributors understand how to participate in our project effectively. Here's a proposed outline by LLM:
We will need a CONTRIBUTING.md file. We need to check if this can be added as "template" to be re-used over all our repositories.
-
Introduction: Welcome message and overview of the contribution process.
-
Getting Started:
- How to fork and clone the repository
- Setting up the development environment
- Running tests
-
How to Contribute:
- Reporting bugs (with issue template)
- Suggesting enhancements (with feature request template)
- Code contributions
- Branching model (e.g., feature branches, hotfix branches)
- Commit message format
- Pull request process
-
Coding Standards:
- Code style guide
- Documentation requirements
-
Community:
- Communication channels (e.g., Discord, mailing list)
- Code of Conduct reference
-
Review Process: Explanation of how contributions are reviewed and merged.
We need to establish clear contributing guidelines to help new contributors understand how to participate in our project effectively. Here's a proposed outline by LLM:
We will need a CONTRIBUTING.md file. We need to check if this can be added as "template" to be re-used over all our repositories.
Introduction: Welcome message and overview of the contribution process.
Getting Started:
How to Contribute:
Coding Standards:
Community:
Review Process: Explanation of how contributions are reviewed and merged.