Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
170 lines (127 loc) · 5.93 KB

CONTRIBUTING.md

File metadata and controls

170 lines (127 loc) · 5.93 KB

Contributing

General Workflow

  1. Fork the repo

  2. Cut a namespaced feature branch from master

  • feature-name
  1. Make commits to your feature branch. Prefix each commit like so:
  • Add a new feature
  • Fix inconsistent tests [Fixes #0]
  • Refactor...
  • Remove...
  • Test...

  1. When you've finished with your fix or feature, Rebase the master branch with the feature branch. Push it to the origin master and submit a pull request directly to master. Include a description of your changes.

  2. Your pull request will be reviewed by two other maintainers. The point of code reviews is to help keep the codebase clean and of high quality and, equally as important, to help you grow as a programmer. If your code reviewer requests you make a change you don't understand, ask them why.

  3. Fix any issues raised by your code reviwer, and push your fixes as a single new commit.

  4. Once the pull request has been reviewed, it will be merged by another member of the team. Do not merge your own commits.

Detailed Workflow

Fork the repo

Use github’s interface to make a fork of the repo, then add that repo as an upstream remote:

git remote add upstream https://github.com/BigRedZone/CookBuk.git

Cut a namespaced feature branch from master

Your branch should follow this naming convention:

  • feature-name

These commands will help you do this:

git checkout -b `your-branch-name`

Make commits to your feature branch.

Prefix each commit like so

  • Add a new feature
  • Fix inconsistent tests
  • Refactor...
  • Remove...
  • Test...

Make changes and commits on your branch, and make sure that you only make changes that are relevant to this branch. If you find yourself making unrelated changes, make a new branch for those changes.

git add .
git commit

Avoid using the -m suffix for best practice

Commit Message Guidelines

  • Commit messages should be written in the present tense; e.g. "Fix continuous integration script".
  • The first line of your commit message should be a brief summary of what the commit changes. Aim for about 70 characters max. Remember: This is a summary, not a detailed description of everything that changed.
  • If you want to explain the commit in more depth, following the first line should be a blank line and then a more detailed description of the commit. This can be as detailed as you want, so dig into details here and keep the first line short.

Rebase upstream changes into your branch

Once you are done making changes, you can begin the process of getting your code merged into the main repo. Step 1 is to pull upstream changes to the master branch into yours by running this command from your branch:

git pull upstream master

This will start the merging process. You must commit all of your changes before doing this. If there are no conflicts, this should just roll all of your changes back on top of the changes from upstream, leading to a nice, clean, linear commit history.

If there are conflicting changes, git will start yelling at you part way through the rebasing process. Git will pause merging to allow you to sort out the conflicts. You do this the same way you solve merge conflicts, by checking all of the files git says have been changed in both histories and picking the versions you want. Be aware that these changes will show up in your pull request, so try and incorporate upstream changes as much as possible.

You pick a file by git adding it - you do not make commits during a rebase.

Once you are done fixing conflicts for a specific commit, run:

git add .
git commit

Make a pull request

Make a clear pull request from your fork and branch to the upstream master branch, detailing exactly what changes you made and what feature this should add. The clearer your pull request is the faster you can get your changes incorporated into this repo.

At least two other members MUST give your changes a code review, and once they are satisfied they will merge your changes into upstream. Alternatively, they may have some requested changes. You should make more commits to your branch to fix these, then follow this process again from rebasing onwards.

Once you get back here, make a comment requesting further review and someone will look at your code again. If they like it, it will get merged, else, just repeat again.

Thanks for contributing!

Guidelines

  1. Uphold the current code standard:
  2. Run the tests before submitting a pull request.
  3. Tests are very, very important. Submit tests if your pull request contains new, testable behavior.
  4. Your pull request is comprised of a single squashed commit.

Checklist:

This is just to help you organize your process

  • Did I cut my work branch off of master (don't cut new branches from existing feature brances)?
  • Did I follow the correct naming convention for my branch?
  • Is my branch focused on a single main change?
  • Do all of my changes directly relate to this change?
  • Did I rebase the upstream master branch after I finished all my work?
  • Did I write a clear pull request message detailing what changes I made?
  • Did I get a code review?
  • Did I make any requested changes from that code review?

If you follow all of these guidelines and make good changes, you should have no problem getting your changes merged in.