Skip to content

Commit 850d7b5

Browse files
committed
contribution notes updated
1 parent 9de4f08 commit 850d7b5

1 file changed

Lines changed: 38 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,47 @@
11
# Contributing
22

3-
We love pull requests. Here's a quick guide.
43

5-
Fork, then clone the repo:
4+
## Notes about branches
5+
6+
This project follows the principles of the
7+
[GitFlow branching model](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/)
8+
as [proposed by Vincent Driessen](http://nvie.com/posts/a-successful-git-branching-model/). According to this model you
9+
will find these branches at the GitHub project page:
10+
11+
- The [master branch](https://github.com/OpenIndex/RemoteSupportTool/tree/master) contains the current stable
12+
releases. No development is directly taking place in that branch.
13+
14+
- The [develop branch](https://github.com/OpenIndex/RemoteSupportTool/tree/develop) represents the current state of
15+
development. Changes from this branch are merged into
16+
[master](https://github.com/OpenIndex/RemoteSupportTool/tree/master) when a new version is released.
17+
18+
- For more complex features you may also find different feature branches. These are derived from
19+
[develop branch](https://github.com/OpenIndex/RemoteSupportTool/tree/develop) and are merged back / removed as
20+
soon as the feature is ready for release.
21+
22+
> **Notice:** If you like to provide changes to this project, you should always use the
23+
> [develop branch](https://github.com/OpenIndex/RemoteSupportTool/tree/develop) as basis for your customization. Feel
24+
> free to create separate feature branches for any custom feature you like to share.
25+
26+
27+
## Create a pull request
28+
29+
We love pull requests. Here's a quick guide.
630

7-
git clone git@github.com:your-username/RemoteSupportTool.git
31+
- Fork this project into you GitHub profile.
832

9-
Do your changes, push to your fork and [submit a pull request](https://github.com/OpenIndex/RemoteSupportTool/compare/).
33+
- Clone the [develop branch](https://github.com/OpenIndex/RemoteSupportTool/tree/develop) of the repository to your
34+
local disk:
35+
```
36+
git clone -b develop git@github.com:your-username/RemoteSupportTool.git
37+
```
38+
39+
- Do your changes to the local repository and push the changes back into your fork at GitHub.
40+
41+
- [Submit a pull request](https://github.com/OpenIndex/RemoteSupportTool/compare/) with the changes from your fork.
1042
11-
At this point you're waiting on us. We like to comment on pull requests as soon
12-
as possible. We may suggest some changes or improvements or alternatives.
43+
At this point you're waiting on us. We like to comment on pull requests as soon as possible. We may suggest some changes
44+
or improvements or alternatives.
1345
1446
Some things that will increase the chance that your pull request is accepted:
1547

0 commit comments

Comments
 (0)