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

Commit b5b25d1

Browse files
author
z
committed
sectios rearranged
1 parent 1114105 commit b5b25d1

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ Coderplex has adopted [Contributor Covenant](https://github.com/coderplex/coderp
1414
## Open Development
1515
All work related to the application takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and to engage open source contributors. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management tool. We maintain [Wiki](https://github.com/coderplex/coderplex/wiki) for structuring our long term thoughts. Both core team members and contributors sends a pull request which goes through the same review process. Whole process is as transparent as it can be and we strive to keep it that way.
1616

17+
## Branching Model
18+
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).
19+
It is highly recommended for both maintainers and contributors to raise a pull request to `develop` branch. Before every release we throughly test develop branch and merge into master.
20+
![Imgur](https://i.imgur.com/KPO2dLul.png)
21+
<br/>
22+
*A pull request to any other branch may most likely be closed by our bots.*
23+
1724
## Development Workflow
1825

1926
We welcome pull requests from beginners and seasoned javaScript developers alike!
@@ -23,10 +30,6 @@ We welcome pull requests from beginners and seasoned javaScript developers alike
2330
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.
2431
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.
2532

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.
3033

3134
### Proposing a Change
3235
1. Open a new issue if you would like report a bug or suggest improvements.
@@ -55,7 +58,11 @@ Hence it is recommended for both maintainers and contributors to raise a pull re
5558
<br/>
5659
Familiarity with git is mandatory.
5760
58-
### Running
61+
### Sending a Pull Request
62+
63+
*Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)*
64+
65+
#### Running Locally
5966
6067
1. Clone repository
6168
```bash
@@ -76,10 +83,6 @@ Hence it is recommended for both maintainers and contributors to raise a pull re
7683
App now opens at `localhost:3000` in your default browser.
7784
> You may get this [error]() if any other app is already running the above port.
7885
79-
### Sending a Pull Request
80-
81-
*Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)*
82-
8386
#### Before submitting:
8487
1. Fork the [repository](https://github.com/coderplex/coderplex).
8588
2. From your fork, create a [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) and name it. eg. `typo-in-readme`

0 commit comments

Comments
 (0)