Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "RAP/Git"
< RAP
(Add Resources section, RAP category) |
(→Resources) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | == | + | == Repositories == |
| − | We've agreed on a common structure for all our | + | All RAP source code is hosted in [[Git]] repositories. We use [[GitHub]] to review changes by committers and contributors. |
| + | |||
| + | See https://www.eclipse.org/rap/source/ for current information. | ||
| + | |||
| + | == Common Repository Structure == | ||
| + | |||
| + | We've agreed on a common structure for all our Git repositories: | ||
; bundles/ | ; bundles/ | ||
| Line 11: | Line 17: | ||
; tests/ | ; tests/ | ||
: unit test projects | : unit test projects | ||
| + | ; examples/ | ||
| + | : for bundles containing exemplary applications and demo code | ||
| + | |||
| + | == Git Practices == | ||
| + | |||
| + | === 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 | |
| + | [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 | ||
| − | + | 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 == | ||
| − | * [[Git]] | + | * [[Git]] at Eclipse |
| + | * [[GitHub]] at Eclipse | ||
[[Category:RAP]] | [[Category:RAP]] | ||
Latest revision as of 12:45, 21 April 2022
Contents
Repositories
All RAP source code is hosted in Git repositories. We use GitHub to review changes by committers and contributors.
See https://www.eclipse.org/rap/source/ for current information.
Common Repository 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
- examples/
- for bundles containing exemplary applications and demo code
Git Practices
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.