-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Description
To make this open-source project ready for external contributions, the following components are needed:
1. Contribution Workflow
Proposed Workflow:
- Planning a change? ➡️ Create an Issue
- On issue creation, maintainers are automatically notified
- Discussion between maintainers and contributor
- Agreement on a clear Definition of Done
- A maintainer assigns a responsible contributor to the issue
- Contributor opens a Pull Request (PR) referencing the issue
- CI runs to validate the build and tests
- Maintainers are automatically assigned as reviewers
- The PR includes a relevant changelog entry
- The PR is reviewed and approved
- The PR is merged
- On merge, CI triggers a new release with an updated version number
2. A CONTRIBUTING.md Guide
Guide to explain:
- How to propose changes
- Contribution checklist
3. Issue & PR Templates
Templates for:
- Bug reports
- Feature requests
- Pull Requests
4. CODEOWNERS File
Define maintainers per directory or file to:
- Automatically request reviews
- Clarify code responsibilities
5. CI for PR Checks
- Run tests
- Lint code
- Ensure formatting
6. CI for Release Version Updates
- Automatically bump semantic version based on PR labels or commit messages
7. CI for Publishing Releases
8. CHANGELOG.md
Maintain a clean and categorized changelog documenting referencing keepachangelog
- Added
- Changed
- Fixed
- Removed
9. Linter & Formatter
- Enforce consistent code style
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels