Skip to content
This repository was archived by the owner on Mar 9, 2021. It is now read-only.

Commit 1114105

Browse files
author
z
committed
branching system added
1 parent 470eba2 commit 1114105

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ We welcome pull requests from beginners and seasoned javaScript developers alike
2323
2. If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.
2424
3. If somebody claims an issue but doesn’t follow up for more than a weeks, it’s fine to take over it but you should still leave a comment.
2525

26+
### Branching Model
27+
The `master` branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for that particular branch i.e any changes in that branch gets reflected in [https://coderplex.org](https://coderplex.org). Before every release we throughly test develop branch and merge into master.
28+
![Imgur](https://i.imgur.com/KPO2dLul.png)
29+
Hence it is recommended for both maintainers and contributors to raise a pull request to `develop` branch.
2630

2731
### Proposing a Change
2832
1. Open a new issue if you would like report a bug or suggest improvements.
@@ -91,7 +95,7 @@ We welcome pull requests from beginners and seasoned javaScript developers alike
9195
6. Add and commit your code. Please give meaning full commit messages.
9296
7. Pull latest code from [upstream repository's ](https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/)`master`, if in case anything new were merged while you were working on your fork.
9397
8. Push the code to your fork.
94-
9. Raise the pull request from your created branch to `master` branch of coderplex.
98+
9. Raise the pull request from your created branch to `develop` branch of coderplex. [why develop instead of master branch?]()
9599
10. Take some time to give a brief description of the work you have done.
96100

97101
#### After submitting
@@ -155,3 +159,6 @@ Error: listen EADDRINUSE :::3000
155159
error Command failed with exit code 1.
156160
```
157161
If you get this error while running `yarn dev` then probably another app is occupying `localhost:3000`. You may want to close that and run the command again.
162+
163+
##### 3. Why we recommend sending new pull requests to `develop` instead of `master` branch ?
164+
The master branch of coderplex is relatively stable branch which we update for every release. We also have auto deployment in place for master branch i.e any changes in that branch gets reflected in `https://coderplex.org`. Every release we throughly test develop branch and merge into master. Hence it is recommended for both maintainers and contributors to raise a pull request to `develop` branch.

0 commit comments

Comments
 (0)