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 "Linux Tools Project/Git"
(add more details on commit messages) |
m (→Commit messages) |
||
| Line 26: | Line 26: | ||
Taken directly from http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html, the format of an ideal commit message: | Taken directly from http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html, the format of an ideal commit message: | ||
| − | < | + | <tt> |
Capitalized, short (50 chars or less) summary | Capitalized, short (50 chars or less) summary | ||
| Line 48: | Line 48: | ||
- Use a hanging indent | - Use a hanging indent | ||
| − | </ | + | </tt> |
== Branches == | == Branches == | ||
Revision as of 09:29, 19 August 2011
{{#eclipseproject:technology.linux-distros}}
| Linux Tools | |
| Website | |
| Download | |
| Community | |
| Mailing List • Forums • IRC • mattermost | |
| Issues | |
| Open • Help Wanted • Bug Day | |
| Contribute | |
| Browse Source |
Contents
Git for Linux Tools
In late February 2011, we moved from SVN to Git. Our SVN repositories were joined into one Git repository (and one for eclipse-build).
Repository
- http://git.eclipse.org/c/linuxtools/org.eclipse.linuxtools.git/ web
- git://git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (anonymous)
- http://git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (anonymous)
- ssh://<committerId>@git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git (committers)
First steps
- Learn about Git: Git, Pro Git, The Git Parable, Git Immersion
- Read about Git at Eclipse
- Note the process by which things must be committed at eclipse.org
Commit messages
From this guide which is no longer accessible as of 2011-08-19:
- make the first line a concise summary of the changes introduced by the commit, <= 50 characters in length
- if there are any technical details that cannot fit in the summary, put them in the body instead.
- wrap lines in the body to <= 72 characters
- write entries in the present tense (just like with ChangeLog entries): "Fix bug #111", not
"Fixed bug #111"
Taken directly from http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html, the format of an ideal commit message:
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
Branches
Please ensure that you fetch and rebase rather than merge. When new branches are created, please use the "rebase" pull strategy. This is documented in the EGit User Guide: EGit/User_Guide#Branch_Creation_Dialog and is performed on the commandline like so:
git config branch.<branchname>.rebase true
- Branches created for bug fixes
- prefix the name with the bug # and a 'very' short description (ex. 307258-automake-tabs-to-spaces)
- Release branches
- stable-Major.Minor
- Branches specific to a sub-project
- namespaced (ex. valgrind/remote, lttng/super-awesome-feature)
Tags
- Tag each release with vMajor.Minor.Micro
- See Semantic Versioning for more details
More reading
- MDT/OCL/Dev/EGit OCL project guide
- Platform-releng/Git_Workflows Eclipse Platform Git Workflows