Skip to content

Latest commit

 

History

History
168 lines (124 loc) · 6.3 KB

CONTRIBUTING.md

File metadata and controls

168 lines (124 loc) · 6.3 KB
Raw

Contributing to Autolab

Reporting Bugs

  1. Always update to the most recent master release; the bug may already be resolved.

  2. Search for similar issues on the Issue Tracker; it may already be an identified problem.

  3. Make sure you can reproduce your problem and clearly describe the steps to reproduce it. Screenshots and error traces help a ton here!

  4. If possible, submit a Pull Request with a failing test or fix the bug yourself (jump down to the "Contributing (Step-by-step)" section).

  5. When the bug is fixed, we will do our best to update the issue on the tracker as soon as possible. Keep in mind that the bugfix will likely first land to the develop branch, but it won't be marked as resolved until it makes it into the master branch.

Requesting New Features

  1. Provide a clear and detailed explanation of the feature you want and why it's important to add. The feature must apply to a wide array of users of Autolab. You may also want to provide us with some advance documentation on the feature, which will help the community to better understand where it will fit.

  2. If you're an awesome developer, build the feature yourself (refer to the "Contributing (Step-by-step)" section below).

Contributing (Step-by-step)

  1. Clone the Repo:

     git clone git@github.com:autolab/Autolab.git

  2. Create a new Branch:

     cd Autolab
 git checkout -b new_autolab_branch

    Please keep your code clean, and limit each branch to one feature or bug-fix. If you find multiple bugs you want to fix, make multiple branches and multiple respective pull requests.

  3. Code

  • Adhere to common conventions you see in the existing code
  • Search to see if your new functionality has been discussed on the Issue Tracker, and include updates as appropriate
  1. Follow the Coding Conventions
  • two spaces, no tabs
  • no trailing whitespace, blank lines should have no spaces (you may want to consider getting a plugin for your text editor that shows you this information)
  • use spaces around operators, after commas, colons, semicolons, around { and before }
  • no space after (, [ or before ], )
  • use Ruby 1.9 hash syntax: prefer { a: 1 } over { :a => 1 }
  • prefer class << self; def method; end over def self.method for class methods
  • prefer { ... } over do ... end for single-line blocks, avoid using { ... } for multi-line blocks

However, please note that pull requests consisting entirely of style changes are not welcome on this project. Style changes in the context of pull requests that also refactor code, fix bugs, improve functionality are welcome.

  1. Commit

Crafting good commit messages is a fine art. Good commit messages help organize your thoughts, document your thought for your future self, and communicate to the team why this commit was necessary.

Please follow the conventions described by Tim Pope in A Note About Good Commit Messages.

  1. Update your branch with changes on master
git checkout <YOUR_BRANCH_NAME>
git fetch origin
git rebase origin/master
  1. Push branch to autolab repo
git push origin <YOUR_BRANCH_NAME>
  1. Issue a Pull Request

In order to make a pull request,

  • Navigate to the Autolab repository you just pushed to (e.g. https://github.com/autolab/Autolab)
  • Click "Pull Request" and "New Pull Request".
  • Write your branch name in the branch field (this is filled with master by default)
  • Pick master branch as the target branch on GitHub
  • Ensure the changesets you introduced are included in the "Commits" tab.
  • Ensure that the "Files Changed" incorporate all of your changes.
  • Fill in some details about your potential patch including a meaningful title.
  • Click "Send pull request".
  1. Responding to Feedback

The Autolab team may recommend adjustments to your code. Part of interacting with a healthy open-source community requires you to be open to learning new techniques and strategies; don't get discouraged! Remember: if the Autolab team suggest changes to your code, they care enough about your work that they want to include it, and hope that you can assist by implementing those revisions on your own.

Though we ask you to clean your history and squash commit before submitting a pull-request, please do not change any commits you've submitted already (as other work might be build on top).

Once we've finally accepted your pull request, we'll ask you to make one last squashed commit, which we'll use to merge in your commit.

Notes to Maintainers

Reviewing Pull Requests

  • Be patient. People are busy, and if the person assigned on a PR hasn't responded in a while, just give them a bit more time.
  • Try to use labels like awaiting response, changes requested, and accepted to communicate to others about actions that need to be taken on a PR. Feel free to create a new label if one of the existing ones doesn't quite represent what you'd like to.
  • Try not to create a "needs review" label. It's pretty apparent that open pull requests need review.

Merging Pull Requests

We are trying to curate a linear Git history. If you're looking at a graph of Git commits for the repo, there should only be lines for where the current development branches diverge from master or develop. What this means in practice is that

  • all commits to develop from a feature branch or to master from develop are squashed and are fast-forward only
  • all commits to master from hotfix branches are immediately cherry-picked and pushed to develop
  • if a commit from a PR is ever cherry-picked to hotfix an issue, the original PR is to be rebased with that commit dropped

Since how to achieve these goals will differ based on the situation, please mention in the appropriate PR if you need help getting up to speed with Git to make this happen. For starters, this wiki article describes what to do in most cases.