Please refrain from using GitHub to report Issues, as we have since moved our main Issue Tracking to JIRA. Feel free to report any Issues there.
- You are free to commit to the develop branch directly if you are a Tech Rat Team member.
- Fork the main repo on github
- Create a feature branch
- Develop your feature/fix/whatever
- Rebase onto upstream develop
- Submit a PR
Make a feature branch off of master using git checkout -b feature/my-awesome-feature. Instead of 'feature' you can also put 'fix' in front of the branch name if it's a bugfix or 'doc' if you only add documentation.
After branching, you should immediately use git push -u origin feature/my-awesome-feature to make that the default upstream ref.
Before opening a PR, rebase onto develop so your PR can be merged fast-forward only, without merge commits. The easiest way to do that is to make the main repo a remote using git remote add upstream [email protected]:fuelrats/pipsqueak and then running git pull --rebase upstream develop. Your PR should have sensible commits with sensible commit messages. It is not required or appreciated to squash PRs into a single commit. Every commit by itself should leave the codebase in a working state.
Use comments and docstrings.