- Notifications
You must be signed in to change notification settings - Fork2
CONTRIBUTING.MD
61 lines (37 loc) · 2.07 KB
CONTRIBUTING.MD
Thank you for taking the time to contribute! We appreciate any help in improving mpvQC, whether it’s fixing bugs oradding new features.
Conventional Commits:
We useConventional Commits to structure our commit messages. Examples:fix: correct minor typos in code
feat: add new pirmary colors
Descriptive PRs:
- Provide a clear title and description.
- Link any relevant issues (e.g., “Fixes #42”).
- Keep your changes focused and self-contained.
Code Reviews:
- Be open to feedback and discussion.
- Make any requested changes or clarifications promptly.
- Run
just lint-python
to check for any lint issues. - Use
just format
to automatically format your code.
- If you add or modify functionality, please include or update tests when possible.
- Ensure all existing tests pass before making a pull request.
- Search First: Check if an issue already exists for your topic.
- Create a New Issue: Clearly describe the bug or problem, including steps to reproduce it, and provide any relevantsystem information if applicable.
- If you’d like to implement a new feature,please open a new issue (or join a relevant discussion if one exists)before you start coding. This way, we can coordinate and ensure your contribution aligns with project goals.
By contributing to mpvQC, you agree that your contributions will be licensed under the same license that governs thisproject. SeeLICENSE for details.