Skip to content
This repository was archived by the owner on Oct 27, 2020. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (18 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

30 lines (18 loc) · 1.49 KB

Reporting Issues

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.

Contributing

IT IS STRONGLY ADVISED TO CONTACT A TECH RAT ON IRC BEFORE WORKING ON THIS PROJECT.

THIS BOT IS END-OF-LIFE AND WE PERFORM MAINTENANCE TASKS ONLY.

  • You are free to commit to the develop branch directly if you are a Tech Rat Team member.
  1. Fork the main repo on github
  2. Create a feature branch
  3. Develop your feature/fix/whatever
  4. Rebase onto upstream develop
  5. Submit a PR

Feature branches

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.

Hygiene

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 git@github.com: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.

Documentation

Use comments and docstrings.