Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 2.37 KB

Contributing Guidelines

Basic Guidelines

All PRs made to this project must follow these simple guidelines:

  • Any PR much have a useful description and must link the issue the request is made against.
  • The commit messages in the pr must be small and precise, describing what they do clearly.
  • The original formatting of the files edited in the PR shouldn't be changed and must be followed religiously.
  • If your pr makes big changes with the file formatting it wouldn't be accepted.

Advice on pull requests

Pull requests are the easiest way to contribute changes to git repos at Github. They are the preferred contribution method, as they offer a nice way for commenting and amending the proposed changes.

  • You need a local "fork" of the Github repo.

  • Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request. Workflow using "feature_x" as the example:

    • Update your local git fork to the tip (of the master, usually)
    • Create the feature branch with git checkout -b feature_x
    • Edit changes and commit them locally
    • Push them to your Github fork by git push -u origin feature_x. That creates the "feature_x" branch at your Github fork and sets it as the remote of this branch
    • When you now visit Github, you should see a proposal to create a pull request

  • If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then use git push to automatically update the pull request.

  • If you need to change something in the existing pull request (e.g. to add a missing signed-off-by line to the commit message), you can use git push -f to overwrite the original commits. That is easy and safe when using a feature branch. Example workflow:

    • Checkout the feature branch by git checkout feature_x
    • Edit changes and commit them locally. If you are just updating the commit message in the last commit, you can use git commit --amend to do that
    • If you added several new commits or made other changes that require cleaning up, you can use git rebase -i HEAD~X (X = number of commits to edit) to possibly squash some commits
    • Push the changed commits to Github with git push -f to overwrite the original commits in the "feature_x" branch with the new ones. The pull request gets automatically updated.