Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "RAP/Git"
< RAP
m (→RAP Runtime) |
(Added section on commit messages) |
||
| Line 1: | Line 1: | ||
| − | == Common Structure == | + | == Repositories == |
| + | |||
| + | === Common Structure === | ||
We've agreed on a common structure for all our Git repositories: | We've agreed on a common structure for all our Git repositories: | ||
| Line 12: | Line 14: | ||
: unit test projects | : unit test projects | ||
| − | == RAP Runtime == | + | === RAP Runtime === |
There will be one repository for RAP itself (a.k.a. the runtime): | There will be one repository for RAP itself (a.k.a. the runtime): | ||
| Line 22: | Line 24: | ||
Note: The project 'org.apache.tomcat' that used to be in runtime.rwt.test in CVS has been moved into its own Git repository {{Git|rap|org.apache.tomcat.git}}. If possible this project should be reused from the Gemini project (or from Orbit) in the future. | Note: The project 'org.apache.tomcat' that used to be in runtime.rwt.test in CVS has been moved into its own Git repository {{Git|rap|org.apache.tomcat.git}}. If possible this project should be reused from the Gemini project (or from Orbit) in the future. | ||
| − | == RAP Tools == | + | === RAP Tools === |
.. and one repository for the RAP Tools: | .. and one repository for the RAP Tools: | ||
| Line 30: | Line 32: | ||
* ssh://COMMITTER_ID@git.eclipse.org/gitroot/rap/org.eclipse.rap.tools.git | * ssh://COMMITTER_ID@git.eclipse.org/gitroot/rap/org.eclipse.rap.tools.git | ||
| − | == RAP Incubator == | + | === RAP Incubator === |
The RAP Incubator project is partitioned into components. Every component has its own repository: | The RAP Incubator project is partitioned into components. Every component has its own repository: | ||
| Line 37: | Line 39: | ||
* git://git.eclipse.org/gitroot/rap/incubator/org.eclipse.rap.incubator.COMPONENT.git (read-only) | * git://git.eclipse.org/gitroot/rap/incubator/org.eclipse.rap.incubator.COMPONENT.git (read-only) | ||
* ssh://COMMITTER_ID@git.eclipse.org/gitroot/rap/incubator/org.eclipse.rap.incubator.COMPONENT.git | * ssh://COMMITTER_ID@git.eclipse.org/gitroot/rap/incubator/org.eclipse.rap.incubator.COMPONENT.git | ||
| + | |||
| + | == Working with Git == | ||
| + | |||
| + | === Commit messages === | ||
| + | |||
| + | Commit messages should follow the recommended format described in | ||
| + | [http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html 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 == | == Resources == | ||
Revision as of 10:51, 3 July 2012
Contents
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):
- git://git.eclipse.org/gitroot/rap/org.eclipse.rap.git (read-only)
- ssh://COMMITTER_ID@git.eclipse.org/gitroot/rap/org.eclipse.rap.git
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:
- git://git.eclipse.org/gitroot/rap/org.eclipse.rap.tools.git (read-only)
- ssh://COMMITTER_ID@git.eclipse.org/gitroot/rap/org.eclipse.rap.tools.git
RAP Incubator
The RAP Incubator project is partitioned into components. Every component has its own repository:
- list of incubator repositories
- git://git.eclipse.org/gitroot/rap/incubator/org.eclipse.rap.incubator.COMPONENT.git (read-only)
- ssh://COMMITTER_ID@git.eclipse.org/gitroot/rap/incubator/org.eclipse.rap.incubator.COMPONENT.git
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