Skip to content

Latest commit

 

History

History
138 lines (102 loc) · 5.28 KB

CONTRIBUTING.md

File metadata and controls

138 lines (102 loc) · 5.28 KB
Raw

Contributing

General workflow

  1. Fork the repo
  2. Create a new branch from the development branch (see: branch naming guidelines)
  3. Make commits to your branch
  4. When you've finished with your fix or feature:
    • Rebase upstream changes into your branch
    • Submit a pull request to the development branch
    • Include a description of your changes
  5. Your pull request will be reviewed by CoinAlpha's development team.
  6. Fix any issues raised by your code reviewer, and push your fixes as a single new commit.
  7. Once the pull request has been reviewed and accepted, it will be merged by a member of the CoinAlpha development team.

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/CoinAlpha/gateway-api.git

Branch naming guidelines

Your branch should follow this naming convention:

  • feat/...
  • bug/...
  • refactor/...
  • test/...
  • doc/...

These commands will help you do this:

# Creates your branch and brings you there
git checkout -b `your-branch-name`

Make commits to your feature branch

Prefix each commit like so

  • (feat) Add a new feature
  • (fix) Fix inconsistent tests [Fixes #0]
  • (refactor) ...
  • (cleanup) ...
  • (test) ...
  • (doc) ...

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.

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 rebase upstream changes to the development branch into yours by running this command from your branch:

git pull --rebase upstream development

This will start the rebase 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 rebasing 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 rebase --continue

This will continue the rebasing process. Once you are done fixing all conflicts you should run the existing tests to make sure you didn’t break anything, then run your new tests (there are new tests, right?) and make sure they work also.

If rebasing broke anything, fix it, then repeat the above process until you get here again and nothing is broken and all the tests pass.

Make a pull request

Make a clear pull request from your fork and branch to the upstream development 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.

If the development team requests changes, you should make more commits to your branch to address 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 it addresses the requests, it will get merged, else, just repeat again.

Thanks for contributing!

Testing

Tests are very, very important. Submit tests if your pull request contains new, testable behavior.

Checklist:

This is just to help you organize your process

  • Did I create my branch from development (don't create new branches from existing feature branches)?
  • 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 development 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.