summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBobby R. Bruce <bbruce@ucdavis.edu>2019-12-02 12:26:11 -0800
committerBobby R. Bruce <bbruce@ucdavis.edu>2019-12-03 19:12:32 +0000
commit31b965b4f7fadb79aab8639af878fd2babde9bdd (patch)
tree8245736d7ccf3013dea8007ed41f24dd527178f9 /CONTRIBUTING.md
parentc63a00d65737a2f556637945a548a0bbaeb61b39 (diff)
downloadgem5-31b965b4f7fadb79aab8639af878fd2babde9bdd.tar.xz
misc: CONTRIBUTING.md to advise linking Jira Issues in commits
Jira Issue: https://gem5.atlassian.net/browse/GEM5-186 Change-Id: I9fa1471627aed139c0ff207e35a32d9faa82eeb8 Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/23261 Reviewed-by: Jason Lowe-Power <jason@lowepower.com> Reviewed-by: Daniel Carvalho <odanrc@yahoo.com.br> Reviewed-by: Giacomo Travaglini <giacomo.travaglini@arm.com> Maintainer: Jason Lowe-Power <jason@lowepower.com> Tested-by: kokoro <noreply+kokoro@google.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 568d790bb..d3b081b71 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,7 @@
Authors: Jason Lowe-Power
Andreas Sandberg
Steve Reinhardt
+ Bobby R. Bruce
If you've made changes to gem5 that might benefit others, we strongly encourage
you to contribute those changes to the public gem5 repository. There are
@@ -179,6 +180,11 @@ Signed-off-by tag to the commit message. By adding this line, the contributor
certifies the contribution is made under the terms of the Developer Certificate
of Origin (DCO) [https://developercertificate.org/].
+If your change relates to a [Jira Issue](https://gem5.atlassian.net), it is
+advised that you provide a link to the issue in the commit message (or messages
+if the Jira Issue relates to multiple commits). Though optional, doing this
+can help reviewers understand the context of a change.
+
It is imperative that you use your real name and your real email address in
both tags and in the author field of the changeset.