Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md guide #2536

Merged
merged 2 commits into from Nov 28, 2017

Conversation

@camallen
Copy link
Member

commented Nov 21, 2017

Adds a contributing guide, inspired by the rails contributing guide, https://github.com/rails/rails/blob/master/CONTRIBUTING.md

Review checklist

  • First, the most important one: is this PR small enough that you can actually review it? Feel free to just reject a branch if the changes are hard to review due to the length of the diff.
  • If there are any migrations, will they the previous version of the app work correctly after they've been run (e.g. the don't remove columns still known about by ActiveRecord).
  • If anything changed with regards to the public API, are those changes also documented in the apiary.apib file?
  • Are all the changes covered by tests? Think about any possible edge cases that might be left untested.
inspired by the rails contributing guide, https://github.com/rails/rails/blob/master/CONTRIBUTING.md
@camallen camallen requested review from marten and zwolf Nov 28, 2017
@zwolf
zwolf approved these changes Nov 28, 2017
Copy link
Member

left a comment

lgtm, maybe include a link to https://github.com/zooniverse/Panoptes/wiki/Contributing-to-Panoptes which has more specific instructions. Conversely, maybe we re-title that wiki entry.

@camallen

This comment has been minimized.

Copy link
Member Author

commented Nov 28, 2017

will do!

@camallen camallen merged commit efeeff5 into master Nov 28, 2017
3 checks passed
3 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
hound No violations found. Woof!
@marten marten deleted the add_contributing_docs branch Jan 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.