Skip to content

Commit 18781d9

Browse files
authored
Update README.md
1 parent 9dd967a commit 18781d9

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
1-
# guide
2-
Commitground's General guide about contributing
1+
# Welcome to join as a contributor
2+
3+
Thanks for contributing to the Commitground project. This document is about general conventions for Commitground project. However each sub projects may have their own conventions or policie.
4+
5+
6+
If you want to be a full time contributor for Commitground, please contact [Commitplay team](https://commitplay.io). Click [here](mailto:join@commitplay.io) to send an email.
7+
8+
# Branching Convention
9+
10+
Use [Git flow](https://nvie.com/posts/a-successful-git-branching-model/)
11+
12+
- `master`: Latest released versions.
13+
- `pre-release`: Beta versions. This branch is for preparing a release and does not mean a released version.
14+
- `develop`: Alpha versions
15+
- `group/title`: Branches to merge into `develop`, `pre-release`, or `master`.
16+
- groups
17+
- feature: Branch to develop a specific feature. If they are planned for a specific release version, merge them into the `release/version`. Otherwise, merge them into the develop branch.
18+
- `bug/`: Branches to fix bugs which are related to the registered issues.
19+
- `hotfix/`: Branches to fix a released version. Merge them into `master` branch & `develop` branch
20+
- `release/`: Branches to prepare a specific release version. Merged them into `pre-release` & `develop` branch
21+
- examples
22+
Branch name should be descriptive
23+
- `feature/reward-contract-for-contributor`
24+
- `bug/issue-32-selection-error`
25+
26+
**Please work with your forked repository. And sync the forked repo's each branches to the origin(commitground)**

0 commit comments

Comments
 (0)