|
chris@39
|
1 = Contributing to Redmine with git and github
|
|
chris@39
|
2
|
|
chris@39
|
3 (This is a beta document. If you can improve it, fork it and send a patch/pull request.)
|
|
chris@39
|
4
|
|
chris@39
|
5 The official repository is at http://github.com/edavis10/redmine
|
|
chris@39
|
6
|
|
chris@39
|
7 Official branches:
|
|
chris@39
|
8
|
|
chris@39
|
9 * master - is automatically mirrored to svn trunk. DO NOT COMMIT OR MERGE INTO THIS BRANCH
|
|
chris@39
|
10 * [0.6, 0.7, 0.8, 0.9, 1.0,...]-stable - is automatically mirrored to svn release branches. DO NOT COMMIT OR MERGE INTO THIS BRANCH
|
|
chris@39
|
11 * integration-to-svn-trunk - this branch is a git-only branch that will track master (trunk). Any code in here will be eventually merged into master but it may be rebased as any time (git-svn needs to rebase to commit to svn)
|
|
chris@39
|
12 * integration-to-svn-stable-1.0 - this branch is a git-only branch that will track the 1.0-stable branch in svn. Any code in here will be eventually merged into master and 1.0-stable but it may be rebased as any time (git-svn needs to rebase to commit to svn)
|
|
chris@39
|
13
|
|
chris@39
|
14 I (edavis10) might have some other branches on the repository for work in progress.
|
|
chris@39
|
15
|
|
chris@39
|
16 == Branch naming standards
|
|
chris@39
|
17
|
|
chris@39
|
18 Redmine has two kinds of development:
|
|
chris@39
|
19
|
|
chris@39
|
20 * bug fixes
|
|
chris@39
|
21 * new feature development
|
|
chris@39
|
22
|
|
chris@39
|
23 Both bug fixes and new feature development should be done in a branch named after the issue number on Redmine.org. So if you are fixing Issue #6244 your branch should be named:
|
|
chris@39
|
24
|
|
chris@39
|
25 * 6244
|
|
chris@39
|
26 * 6244-sort-people-by-display-name (optional description)
|
|
chris@39
|
27 * issue/6244 (optional "issue" prefix)
|
|
chris@39
|
28 * issue/6244-sort-people-by-display-name (optional prefix and description)
|
|
chris@39
|
29
|
|
chris@39
|
30 That way when the branch is merged into the Redmine core, the correct issue can be updated.
|
|
chris@39
|
31
|
|
chris@39
|
32 Longer term feature development might require multiple branches. Just your best judgment and try to keep the issue id in the name.
|
|
chris@39
|
33
|
|
chris@39
|
34 If you don't have an issue for your patch, create an issue on redmine.org and say it's a placeholder issue for your work. Better yet, add a brief overview of what you are working on to the issue and you might get some help with it.
|
|
chris@39
|
35
|
|
chris@39
|
36 == Coding Standards
|
|
chris@39
|
37
|
|
chris@39
|
38 Follow the coding standards on the Redmine wiki: http://www.redmine.org/wiki/redmine/Coding_Standards#Commits. Make sure you commit logs conform to the standards, otherwise someone else will have to rewrite them for you and you might lose attribution during the conversion to svn.
|
|
chris@39
|
39
|
|
chris@39
|
40
|
