Thanks for taking the time to contribute! The following is a set of guidelines for contributing to our project. We encourage everyone to follow them with their best judgement.
- Nix
- Git
- Fork the repository on GitHub.
- Clone your forked repository to your local machine.
git clone https://github.com/error-fyi/go-fyi.git- Change directory to the cloned repository.
cd go-fyi- Start Nix shell.
source env-dev.sh
develop- Install dependencies.
go get ./...- Create a new branch for your changes.
git checkout -b <issue number>-<branch name>- Make your changes and commit them.
git commit --signoff- Push your changes to your forked repository.
git push origin <issue number>-<branch name>- Open a pull request on GitHub from your forked repository to the original repository.
All contributions will be reviewed by the maintainers of the project. Here are a few things to keep in mind:
- Please fill the given Pull Request template to the best of your abilities.
- Opening an issue before starting a work pieces improves the chances of the work being approved.
For pull requests and branches a standard naming convention will help with automatically linking the development work with the related issue(s). For this reason, please follow the following naming conventions:
- Branches: When creating a new branch the issue number should be added as a prefix
<issue number>-<branch-name> - Commits: The commit body should reference the issue
Related <[#issue number](issue URL)>