Jump to: navigation, search

Difference between revisions of "RAP/Git"

< RAP
(Added section on commit messages)
(Commit messages)
(One intermediate revision by the same user not shown)
Line 41: Line 41:
  
 
== Working with Git ==
 
== Working with Git ==
 +
 +
=== Commits ===
 +
 +
* Make commits of logical units, do not mix different topics in a single commit.
 +
* When splitting up bigger tasks into logical units, every single commit should produce a consistent version, i.e. the test suite must pass after every commit.
 +
* Make sure your commit does not introduce any unnecessary whitespace.
 +
* Make sure your commit does not include any commented code, sysouts, etc.
 +
* Make sure that the tests are included together with the fix.
  
 
=== Commit messages ===
 
=== Commit messages ===
Line 47: Line 55:
 
[http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html this article]:
 
[http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html this article]:
  
  Capitalized, short (50 chars or less) summary
+
Capitalized, short (50 chars or less) summary
 
+
  More detailed explanatory text, if necessary.  Wrap it to about 72
+
More detailed explanatory text, if necessary.  Wrap it to about 72
  characters or so.  In some contexts, the first line is treated as the
+
characters or so.  In some contexts, the first line is treated as the
  subject of an email and the rest of the text as the body.  The blank
+
subject of an email and the rest of the text as the body.  The blank
  line separating the summary from the body is critical (unless you omit
+
line separating the summary from the body is critical (unless you omit
  the body entirely); tools like rebase can get confused if you run the
+
the body entirely); tools like rebase can get confused if you run the
  two together.
+
two together.
 
+
  Write your commit message in the present tense: "Fix bug" and not "Fixed
+
Write your commit message in the present tense: "Fix bug" and not "Fixed
  bug."  This convention matches up with commit messages generated by
+
bug."  This convention matches up with commit messages generated by
  commands like git merge and git revert.
+
commands like git merge and git revert.
 
+
  Further paragraphs come after blank lines.
+
Further paragraphs come after blank lines.
 
+
  - Bullet points are okay, too
+
- Bullet points are okay, too
 
+
  - Typically a hyphen or asterisk is used for the bullet, preceded by a
+
- Typically a hyphen or asterisk is used for the bullet, preceded by a
    single space, with blank lines in between, but conventions vary here
+
  single space, with blank lines in between, but conventions vary here
 
+
  - Use a hanging indent
+
- Use a hanging indent
 +
 
 +
Some further advice can be found [http://www.kernel.org/pub/software/scm/git/docs/v1.7.6.5/SubmittingPatches here].
 +
 
 +
* The commit message should be understandable when reading through the commit log. That's why it should be simple and should make sense also without context.
 +
 
 +
* The body should explain the problem and the solution. It should also point out why the solution has been chosen, and what other alternatives have been considered, but discarded.
 +
 
 +
* The explanation should be understandable without external resources. It's good to provide the URL to a discussion or a bug, but the important points should also be summarized in the commit message.
 +
 
 +
=== Committing patches ===
 +
 
 +
* Make use the Author field in the commit is set to the original author.
 +
 
 +
* When committing a patch from someone else, add a "Signed-off-by: Committer Name <committer@email>" line to the commit message, to confirm that you agree with the patch and made sure the patch is IP clean.
  
 
== Resources ==
 
== Resources ==

Revision as of 10:52, 3 July 2012

Repositories

Common Structure

We've agreed on a common structure for all our Git repositories:

bundles/
all bundle projects
features/
feature projects
releng/
projects for release engineering
tests/
unit test projects

RAP Runtime

There will be one repository for RAP itself (a.k.a. the runtime):

Note: The project 'org.apache.tomcat' that used to be in runtime.rwt.test in CVS has been moved into its own Git repository org.apache.tomcat.git (browse, stats, fork on OrionHub) . If possible this project should be reused from the Gemini project (or from Orbit) in the future.

RAP Tools

.. and one repository for the RAP Tools:

RAP Incubator

The RAP Incubator project is partitioned into components. Every component has its own repository:

Working with Git

Commits

  • Make commits of logical units, do not mix different topics in a single commit.
  • When splitting up bigger tasks into logical units, every single commit should produce a consistent version, i.e. the test suite must pass after every commit.
  • Make sure your commit does not introduce any unnecessary whitespace.
  • Make sure your commit does not include any commented code, sysouts, etc.
  • Make sure that the tests are included together with the fix.

Commit messages

Commit messages should follow the recommended format described in this article:

Capitalized, short (50 chars or less) summary

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

Write your commit message in the present tense: "Fix bug" and not "Fixed
bug."  This convention matches up with commit messages generated by
commands like git merge and git revert.

Further paragraphs come after blank lines.

- Bullet points are okay, too

- Typically a hyphen or asterisk is used for the bullet, preceded by a
  single space, with blank lines in between, but conventions vary here

- Use a hanging indent

Some further advice can be found here.

  • The commit message should be understandable when reading through the commit log. That's why it should be simple and should make sense also without context.
  • The body should explain the problem and the solution. It should also point out why the solution has been chosen, and what other alternatives have been considered, but discarded.
  • The explanation should be understandable without external resources. It's good to provide the URL to a discussion or a bug, but the important points should also be summarized in the commit message.

Committing patches

  • Make use the Author field in the commit is set to the original author.
  • When committing a patch from someone else, add a "Signed-off-by: Committer Name <committer@email>" line to the commit message, to confirm that you agree with the patch and made sure the patch is IP clean.

Resources

  • Git - general introduction to git at Eclipse