summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Wen <jrw2175@columbia.edu>2016-05-12 00:56:40 -0400
committerJames Wen <jrw2175@columbia.edu>2016-05-12 00:56:40 -0400
commitd695cb41ee180f1191fa141298a55d7214e91cc5 (patch)
tree2dd08afb9ab7041765b355b2d814005d706895cf
parent8d3eb4aa0a3286d219c78a05bf1ab47c784fc25c (diff)
downloadbundler-avoid-tag-or-id-refs-in-commits.tar.gz
[Documentation] Add instruction to not use tags or id refsavoid-tag-or-id-refs-in-commits
-rw-r--r--DEVELOPMENT.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 08f1978c07..72d65be838 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -60,6 +60,12 @@ Before you submit a pull request, please remember to do the following:
$ bin/rspec spec/bundler
$ bin/rspec spec/commands/update_spec.rb
+- Please ensure that the commit messages included in the pull request __do not__ have the following:
+ - `@tag` Github user or team references (ex. `@indirect` or `@bundler/core`)
+ - `#id` references to issues or pull requests (ex. `#43` or `bundler/bundler-site#12`)
+
+ If you want to use these mechanisms, please instead include them in the pull request description. This prevents multiple notifications or references being created on commit rebases or pull request/branch force pushes.
+
# Bug triage
Triage is the work of processing tickets that have been opened into actionable issues, feature requests, or bug reports. That includes verifying bugs, categorizing the ticket, and ensuring there's enough information to reproduce the bug for anyone who wants to try to fix it.