Project

General

Profile

Rule of Shared Repository » History » Version 3

Kousuke Ebihara, 2009-10-06 21:11
Added explain automatically fixed

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 1 Kousuke Ebihara
h2. Repository Collaborators
12 1 Kousuke Ebihara
13 1 Kousuke Ebihara
Repository collaborators can handle the shared repository.
14 1 Kousuke Ebihara
15 1 Kousuke Ebihara
The following is the list of current collaborators (as of October 6, 2009):
16 1 Kousuke Ebihara
* "ebihara":https://github.com/ebihara
17 1 Kousuke Ebihara
* "balibali":https://github.com/balibali
18 1 Kousuke Ebihara
* "ShinichiU":https://github.com/ShinichiU
19 1 Kousuke Ebihara
* "fukamachi":https://github.com/fukamachi
20 1 Kousuke Ebihara
* "uzura8":https://github.com/uzura8
21 1 Kousuke Ebihara
* "nothan":https://github.com/nothan
22 1 Kousuke Ebihara
* "kawahara":https://github.com/kawahara
23 1 Kousuke Ebihara
24 1 Kousuke Ebihara
If you think that you are worthy of repository collaborators, please tell your GitHub account to ebihara@tejimaya.com.
25 1 Kousuke Ebihara
26 1 Kousuke Ebihara
h2. Committing
27 1 Kousuke Ebihara
28 1 Kousuke Ebihara
h3. Direct Committing
29 1 Kousuke Ebihara
30 1 Kousuke Ebihara
Committing direct is not allowed excepting few cases.
31 1 Kousuke Ebihara
32 1 Kousuke Ebihara
Release Manager can directly commit when he works for releasing.
33 1 Kousuke Ebihara
34 1 Kousuke Ebihara
In other cases, anyone must work in his own clone.
35 1 Kousuke Ebihara
36 1 Kousuke Ebihara
h3. Commit Messages
37 1 Kousuke Ebihara
38 1 Kousuke Ebihara
In merging, commit messages must follow the following rule:
39 1 Kousuke Ebihara
* A message must be written in English. A message can contain other languages, but that must be explained in English.
40 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
41 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)"
42 1 Kousuke Ebihara
* A message must tell everyone what the commit is.
43 1 Kousuke Ebihara
44 1 Kousuke Ebihara
A commit that doesn't follow this rule, most likely is rejected.
45 1 Kousuke Ebihara
46 1 Kousuke Ebihara
h2. Merging
47 1 Kousuke Ebihara
48 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.
49 1 Kousuke Ebihara
50 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)