Jump to: navigation, search

Difference between revisions of "RAP/Git"

< RAP
(Added section on commit messages)
(Commit messages)
Line 47: Line 47:
 
[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
  
 
== Resources ==
 
== Resources ==

Revision as of 10:51, 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

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

Resources

  • Git - general introduction to git at Eclipse