Problem
Project lacks a CONTRIBUTING.md file, which is a standard for professional open-source projects.
Impact
- Severity: MEDIUM
- Category: Professional Standards
- Unclear how external contributors should:
- Submit pull requests
- Report bugs
- Follow code style
- Run tests
- May deter potential contributors
Required Content
- How to file issues - bug reports vs feature requests
- PR submission process - fork, branch naming, PR description
- Code style requirements - checkstyle, formatting
- Testing requirements - unit tests required for all changes
- Build instructions - how to build and run tests
- CLA/DCO requirements (if any)
- Code of Conduct reference
- Contact information - how to ask questions
Example Template
See https://github.com/github/docs/blob/main/CONTRIBUTING.md
Priority
P1 - High - Should be created before v1.2 release.
Related
- CODE_OF_CONDUCT.md (already exists ✅)
- README.md (has build instructions)
- .github/workflows/quality-gate.yml (defines quality requirements)
Problem
Project lacks a CONTRIBUTING.md file, which is a standard for professional open-source projects.
Impact
Required Content
Example Template
See https://github.com/github/docs/blob/main/CONTRIBUTING.md
Priority
P1 - High - Should be created before v1.2 release.
Related