プロジェクト

全般

プロフィール

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

Kousuke Ebihara, 2012-11-22 18:51

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 6 Kousuke Ebihara
GitHub accounts that are in the following list, can execute "push" operations to shared repository (as of Nov 22, 2012):
14 1 Kousuke Ebihara
15 1 Kousuke Ebihara
* "balibali":https://github.com/balibali
16 6 Kousuke Ebihara
* "ebihara":https://github.com/ebihara
17 6 Kousuke Ebihara
* "imamura623":https://github.com/imamura623
18 6 Kousuke Ebihara
* "kashiwasan":https://github.com/kashiwasan
19 1 Kousuke Ebihara
* "kawahara":https://github.com/kawahara
20 6 Kousuke Ebihara
* "martini2002jp":https://github.com/martini2002jp
21 6 Kousuke Ebihara
* "niryuu":https://github.com/niryuu
22 6 Kousuke Ebihara
* "nise-nabe":https://github.com/nise-nabe
23 6 Kousuke Ebihara
* "ShinichiU":https://github.com/ShinichiU
24 6 Kousuke Ebihara
* "tejima":https://github.com/tejima
25 6 Kousuke Ebihara
* "touri":https://github.com/touri
26 6 Kousuke Ebihara
* "upsilon":https://github.com/upsilon
27 4 Kousuke Ebihara
28 1 Kousuke Ebihara
If you think that you are worthy of repository collaborators, please tell your GitHub account to ebihara@tejimaya.com.
29 6 Kousuke Ebihara
If you think that you are worthy of getting "push" privilege, please tell your GitHub account to ebihara, balibali, or ShinichiU.
30 1 Kousuke Ebihara
31 1 Kousuke Ebihara
h2. Committing
32 1 Kousuke Ebihara
33 1 Kousuke Ebihara
h3. Direct Committing
34 1 Kousuke Ebihara
35 1 Kousuke Ebihara
Committing direct is not allowed excepting few cases.
36 1 Kousuke Ebihara
37 1 Kousuke Ebihara
Release Manager can directly commit when he works for releasing.
38 1 Kousuke Ebihara
39 1 Kousuke Ebihara
In other cases, anyone must work in his own clone.
40 1 Kousuke Ebihara
41 1 Kousuke Ebihara
h3. Commit Messages
42 1 Kousuke Ebihara
43 1 Kousuke Ebihara
In merging, commit messages must follow the following rule:
44 1 Kousuke Ebihara
* A message must be written in English. A message can contain other languages, but that must be explained in English.
45 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
46 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)"
47 1 Kousuke Ebihara
* A message must tell everyone what the commit is.
48 1 Kousuke Ebihara
49 1 Kousuke Ebihara
A commit that doesn't follow this rule, most likely is rejected.
50 1 Kousuke Ebihara
51 1 Kousuke Ebihara
h2. Merging
52 1 Kousuke Ebihara
53 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.
54 1 Kousuke Ebihara
55 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)
56 5 Kousuke Ebihara
57 5 Kousuke Ebihara
h2. Branches
58 5 Kousuke Ebihara
59 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.