summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Wen <jrw2175@columbia.edu>2016-02-17 18:06:05 -0500
committerJames Wen <jrw2175@columbia.edu>2016-02-17 22:36:29 -0500
commitf4ba0111351bd46eb1abd2098b3baa6ffd10f4b8 (patch)
treec59b06eee8d88709029f0a0d5bb6c81f9f3939e4
parent4283169337797eedd81c0f89e705d00e8f00aa0d (diff)
downloadbundler-RochesterinNYC-update-development-submitting-prs.tar.gz
Add pre-PR-submission steps to DEVELOPMENT.mdRochesterinNYC-update-development-submitting-prs
-rw-r--r--DEVELOPMENT.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 464dfec317..0061fe6d80 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -33,6 +33,24 @@ Bundler doesn't use a Gemfile to list development dependencies, because when we
With that set up, you can test changes you've made to Bundler by running `dbundle`, without interfering with the regular `bundle` command.
+# Submitting Pull Requests
+
+Before you submit a pull request, please remember to do the following:
+
+- Make sure the code formatting and styling adheres to the guidelines. We use Rubocop for this. Lack of formatting adherence will result in automatic Travis build failures.
+
+ $ bin/rubocop -a
+
+- Please run the test suite:
+
+ $ bin/rspec
+
+- If you are unable to run the entire test suite, please run the unit test suite and at least the integration specs related to the command or domain of Bundler that your code changes relate to.
+
+- Ex. For a pull request that changes something with `bundle update`, you might run:
+
+ $ bin/rspec spec/bundler
+ $ bin/rspec spec/commands/update_spec.rb
# Bug triage