Thank you for considering contributing to the Masternode Setup Tool! This document provides guidelines for contributing to the project, ensuring a consistent and high-quality codebase and a welcoming community.
Fork the Repository: Begin by forking the main repository to your own GitHub account. Clone the Forked Repository: Once you have your fork, you can clone the repository to your local machine and start working:
git clone https://github.com/stratisproject/MasternodeSetupTool.gitCreate a New Branch: Always create a new branch for your work:
git checkout -b feature/your-feature-nameCode Style: Follow the C# coding conventions.
Testing: Ensure that your code passes integration and unit tests.
Commit messages should be clear and descriptive:
Use present tense ("Add feature" not "Added feature") Start the commit message with a capital letter Reference issues or pull requests where possible Example:
Add logging (#123)
Push to Your Fork: Push your changes to your fork:
git push origin feature/your-feature-nameOpen a Pull Request: Navigate to the original project's GitHub page and click "New Pull Request". Choose your branch and ensure the changes are accurate. Provide a clear and comprehensive description of what your PR achieves. Feedback
Your pull request will undergo a review process by the maintainers. They might request some changes, enhancements, or ask questions. This is a natural part of the development process, and feedback should be constructive and aimed at improving the overall quality of the project.
Respect the community and other contributors. If you're unsure about something, don't hesitate to ask!
Enjoy coding and thank you for contributing!