プロジェクト

全般

プロフィール

Rule of Shared Repository » 履歴 » バージョン 9

Rimpei Ogawa, 2014-06-23 14:53

1 1 Kousuke Ebihara
h1. Rule of Shared Repository
2 1 Kousuke Ebihara
3 1 Kousuke Ebihara
h2. Overview
4 1 Kousuke Ebihara
5 1 Kousuke Ebihara
This document provides rule of handling shared repository of developing OpenPNE3.
6 1 Kousuke Ebihara
7 1 Kousuke Ebihara
In this document, the "shared repository" means that is git://github.com/openpne/OpenPNE3.git.
8 1 Kousuke Ebihara
9 1 Kousuke Ebihara
Everyone must follow this rule to handle the shared repository.
10 1 Kousuke Ebihara
11 6 Kousuke Ebihara
h2. "push" privilege to handle shared repository
12 1 Kousuke Ebihara
13 9 Rimpei Ogawa
GitHub accounts that are in the following list, can execute "push" operations to shared repository (as of Jun 23, 2014):
14 1 Kousuke Ebihara
15 6 Kousuke Ebihara
* "balibali":https://github.com/balibali
16 1 Kousuke Ebihara
* "martini2002jp":https://github.com/martini2002jp
17 9 Rimpei Ogawa
* "nishizoe":https://github.com/nishizoe
18 6 Kousuke Ebihara
* "ShinichiU":https://github.com/ShinichiU
19 6 Kousuke Ebihara
* "tejima":https://github.com/tejima
20 6 Kousuke Ebihara
* "upsilon":https://github.com/upsilon
21 1 Kousuke Ebihara
22 9 Rimpei Ogawa
If you think that you are worthy of getting "push" privilege, please tell your GitHub account to balibali, nishizoe, ShinichiU, or tejima.
23 1 Kousuke Ebihara
24 1 Kousuke Ebihara
h2. Committing
25 1 Kousuke Ebihara
26 1 Kousuke Ebihara
h3. Direct Committing
27 1 Kousuke Ebihara
28 1 Kousuke Ebihara
Committing direct is not allowed excepting few cases.
29 1 Kousuke Ebihara
30 1 Kousuke Ebihara
Release Manager can directly commit when he works for releasing.
31 1 Kousuke Ebihara
32 1 Kousuke Ebihara
In other cases, anyone must work in his own clone.
33 1 Kousuke Ebihara
34 1 Kousuke Ebihara
h3. Commit Messages
35 1 Kousuke Ebihara
36 1 Kousuke Ebihara
In merging, commit messages must follow the following rule:
37 1 Kousuke Ebihara
* A message must be written in English. A message can contain other languages, but that must be explained in English.
38 2 Kousuke Ebihara
* A message must contain related ticket ID. The ID must be specified with "refs" or "fixes" keyword. We have useful hook script for keeping it: http://gist.github.com/202866
39 1 Kousuke Ebihara
   e.g.  "Added ability to delete member from the mobile_backend application (refs #1)", "Added ability to configure gadgets from the mobile_backend application. Adding support to manage SNS from mobile is now completed. (fixes #1)"
40 1 Kousuke Ebihara
* A message must tell everyone what the commit is.
41 1 Kousuke Ebihara
42 1 Kousuke Ebihara
A commit that doesn't follow this rule, most likely is rejected.
43 1 Kousuke Ebihara
44 1 Kousuke Ebihara
h2. Merging
45 1 Kousuke Ebihara
46 1 Kousuke Ebihara
If you developed something or got "Pull Request", please merge it. After merging, you must check changes. If the changes has some faults, contact author about it to fix them.
47 1 Kousuke Ebihara
48 3 Kousuke Ebihara
If changes looks fine, push it to shared repository, and change a status of the related ticket to "Pending Review". (Changing status is doing automatically if a commit is related with a ticket by the "fixes" keyword in its message)
49 5 Kousuke Ebihara
50 5 Kousuke Ebihara
h2. Branches
51 5 Kousuke Ebihara
52 5 Kousuke Ebihara
Branches of the shared repository must limit the release branches (they contain the master branch). Don't push a branch for your work. You should create such a branch to your repository.