1.5 KiB
Contribution Guidelines
Thank you for considering contributing to the project! We welcome your help and appreciate your support.
General guidelines
- Follow templates: Use the provided issue and pull request templates to ensure consistency and completeness. Be concise.
- Follow Single responisibility principle: Each contribution must correspond to a single area of work. Don't mix them up (e.g. fixing a bug and adding a new feature in the same PR).
- Code of Conduct: Be sure to follow our Code of Conduct.
Contributing Process
-
Create an Issue: Before starting work, check the issue tracker to see if a relevant issue already exists. If not, create a new issue to describe the bug or feature.
-
Get Assigned: Make sure you are assigned to an issue before beginning any work. This helps prevent duplicate efforts.
-
Fork the Repository: Fork the repository and clone it to your local machine.
-
Work on Your Changes: Create a new branch for your work and make your changes.
-
Commit Your Changes: Write clear, concise commit messages.
-
Open a Pull Request (PR): Once your changes are ready, open a PR. Ensure you link the PR to the corresponding issue.
-
Review Process: Be responsive to feedback and make any requested changes.
Additional Notes
Feel free to suggest improvements or ask questions. You can send your feedback to opensource@xfox111.net
Thank you!