Thank you for considering contributing to HackPGH'S DINGUS! We welcome contributions from the community to help improve our Go DINGUS project. Before you start contributing, please take a moment to read and understand the following guidelines.
- Ensure you have Go installed on your local machine.
- Fork the repository on GitHub.
- Clone your fork locally using
git clone https://github.com/hackpgh/DINGUS.git.
- Switch to development branch:
git checkout development - Create a new branch for your work:
git checkout -b feature-name. - Make your changes, ensuring they adhere to our coding standards.
- Write unit tests for your code changes if applicable.
- Commit your changes with clear and concise messages:
git commit -m "Add feature XYZ". - Push your branch to your fork on GitHub:
git push origin feature-name. - Create a pull request (PR) from your branch to the repository's
developmentbranch on GitHub.
- Ensure your PR title is descriptive and summarizes the changes.
- Provide a detailed description of the changes in your PR.
- Make sure your code passes all tests.
- Review and address any feedback or comments on your PR.
- Squash your commits into a single, coherent commit if necessary.
- Follow the Go Code Review Comments.
- Try to maintain a consistent coding style throughout the poject.
Be excellent to each other. If you encounter any bugs, have questions, or want to suggest improvements, please open an issue on the issue tracker.
By contributing to this project, you agree that your contributions will be licensed under the MIT License.
Thank you for helping make HackPGH'S DINGUS better!