Skip to content
The Holocron

Create a Pull Request

If you’re unfamiliar with the Github flow, please read this guide as an introduction. Make sure you reach out to someone on the team before you start any work to ensure that what you’re doing is aligned with the teams’ vision. Read Ilya Grigorik’s great article Don’t “Push” Your Pull Requests. The following passage sums up some great points:

Contributions are always welcome, but surprise patches are mostly a burden. Yes, you are offering your help, but someone else will have to maintain your code over the long term - get their buy-in first, avoid surprises. Even worse, a localized change to address a specific problem will often miss the full implications to the project: other existing use cases, future roadmap plans, or overall architectural decisions. A good idea can be implemented inappropriately for the specific project; it can be invalidated by another effort that you may not even be aware of; the timing may be wrong, and a dozen other reasons can conspire against you.

For those of you willing to help out, thanks!!! Here’s a quick how to submit your changes to GitHub. This requires no need for access, rights or privileges and can be done without any help from a team member.

  1. Fork It by pressing the “Fork” button in the top right corner.
  2. Clone your newly forked repo (git clone https://github.com/<github-user>/<repo>).
  3. Change into the directory you cloned (cd <repo>)
  4. Add your fork as a remote (git remote add <github-user> https://github.com/<github-user>/<repo>) where <github-user> is your actual Github username and <repo> is the repository with which you’re looking to contribute.
  5. Create your feature branch (git checkout -b <my-new-feature>); checkout the guide below for our branching strategy
  6. Commit your changes (git commit), following the format suggested below. Please don’t use the shortcut flag git commit -m <message> as there is more detail required than what is allowed by only using that flag.
  7. Push to the branch (git push <github-user> <my-new-feature>)
  8. Create a new Pull Request; make sure you fill in the Pull Request template.

Gotchas

  • Please avoid working directly on the main branch.
  • Make commits of logical units.
  • Check for unnecessary space with git diff --check before committing.
  • Make sure your commit messages are in the proper format, also listed below in our guides.