Jason Lowe-Power has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/36255 )
Change subject: misc: Minor updates to CONTRIBUTING.md
......................................................................
misc: Minor updates to CONTRIBUTING.md
This brings the file slightly more up to date
Change-Id: I1ed3300ec3c4980ed22c6a6fb950fa724897906b
Signed-off-by: Jason Lowe-Power <ja...@lowepower.com>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/36255
Reviewed-by: Daniel Carvalho <oda...@yahoo.com.br>
Reviewed-by: Matt Sinclair <mattdsincl...@gmail.com>
Maintainer: Jason Lowe-Power <power...@gmail.com>
Tested-by: kokoro <noreply+kok...@google.com>
---
M CONTRIBUTING.md
1 file changed, 22 insertions(+), 5 deletions(-)
Approvals:
Matt Sinclair: Looks good to me, approved
Daniel Carvalho: Looks good to me, approved
Jason Lowe-Power: Looks good to me, approved
kokoro: Regressions pass
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 590c773..10a026e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -97,7 +97,7 @@
Changes should be made to this develop branch. Changes to the stable branch
will be blocked. Once a change on the develop branch is properly
incorporated
-into the gem5 repo it will be merged into the stable Branch upon the next
+into the gem5 repo it will be merged into the stable branch upon the next
release of gem5. New releases of gem5 occur three times a year. Ergo,
changes
made to the develop branch should appear on the stable branch within three
to
four months as part of a stable release.
@@ -109,7 +109,11 @@
* public/m5threads: The code for a pthreads implementation that works with
gem5's syscall emulation mode.
-
+ * public/gem5-resources: Resources to enable computer architecture
research
+ with gem5. See the README.md file in the gem5-resources repository for
more
+ information.
+ * public/gem5-website: The gem5.org website source. See the README.md
file in
+ the gem5-website repository for more information.
Making changes to gem5
======================
@@ -123,6 +127,15 @@
git, you will be able to pull in and merge changes from mainline and simply
keep up with upstream changes.
+We use a rebase-always model for contributions to the develop branch of
gem5.
+In this model, the changes are rebased on top of the tip of develop
instead of
+merged. This means that to contribute, you will have to frequently rebase
any
+feature branches on top of develop. If you see a "merge conflict" in
gerrit, it
+can often be solved with a simple rebase. To find out more information
about
+rebasing and git, see the [git book].
+
+[git book]: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
+
Requirements for change descriptions
------------------------------------
To help reviewers and future contributors more easily understand and track
@@ -165,10 +178,14 @@
automatically with a commit hook by git.
* Tested-by: Used to acknowledge people who tested a patch. Sometimes
added
automatically by review systems that integrate with CI systems.
+ * Issue-On: Used to link a commit to an issue in gem5's [issue tracker].
The
+ format should be https://gem5.atlassian.net/browse/GEM5-<NUMBER>
-Other than the "Signed-off-by", "Reported-by", and "Tested-by" tags, you
-generally don't need to add these manually as they are added automatically
by
-Gerrit.
+[issue tracker]: https://gem5.atlassian.net/
+
+Other than the "Signed-off-by", "Issue-On", "Reported-by", and "Tested-by"
+tags, you generally don't need to add these manually as they are added
+automatically by Gerrit.
It is encouraged for the author of the patch and the submitter to add a
Signed-off-by tag to the commit message. By adding this line, the
contributor
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/36255
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: I1ed3300ec3c4980ed22c6a6fb950fa724897906b
Gerrit-Change-Number: 36255
Gerrit-PatchSet: 2
Gerrit-Owner: Jason Lowe-Power <power...@gmail.com>
Gerrit-Reviewer: Daniel Carvalho <oda...@yahoo.com.br>
Gerrit-Reviewer: Jason Lowe-Power <power...@gmail.com>
Gerrit-Reviewer: Matt Sinclair <mattdsincl...@gmail.com>
Gerrit-Reviewer: kokoro <noreply+kok...@google.com>
Gerrit-MessageType: merged
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
