You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 9, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+80-34Lines changed: 80 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Both of them are under very active development. This document provides non exhau
12
12
Coderplex has adopted [Contributor Covenant](https://github.com/coderplex/coderplex/blob/docs-update/CODE_OF_CONDUCT.md) that we expect project participants to adhere to.
13
13
14
14
## Open Development
15
-
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 maintainers 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.
15
+
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.
16
16
17
17
## Development Workflow
18
18
@@ -26,57 +26,100 @@ We welcome pull requests from beginners and seasoned javaScript developers alike
26
26
27
27
### Proposing a Change
28
28
1. Open a new issue if you would like report a bug or suggest improvements.
29
-
2. Please wait for maintainers to comment on the thread. This lets us reach an agreement on your proposal before you put significant effort into it.
29
+
2. Please wait for core team members to comment on the thread. This lets us reach an agreement on your proposal before you put significant effort into it.
30
30
31
31
### Prerequisites
32
-
##### 1. [NodeJS](https://nodejs.org/)
32
+
1.[NodeJS](https://nodejs.org/)
33
+
<br/>
33
34
Minimum version v8.0.0+
34
-
```bash
35
-
To check node version
36
-
$ node -v
37
-
```
38
-
Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100).
35
+
```bash
36
+
To check node version
37
+
$ node -v
38
+
```
39
+
Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100).
39
40
40
-
> If you face problem updating your node then you might need a Node version manager tool. [Follow here]()
41
+
> If you face problem updating your node then you might need a Node version manager tool. [Follow here]()
41
42
42
-
##### 2.[Yarn](https://yarnpkg.com)
43
-
Minimum version v1.2.0+
44
-
<br/>
45
-
Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab)
43
+
2.[Yarn](https://yarnpkg.com)
44
+
<br/>
45
+
Minimum version v1.2.0+
46
+
<br/>
47
+
Installing instructions are at [official docs](https://yarnpkg.com/en/docs/install#windows-tab).
48
+
Use yarn over npm
49
+
> Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file.
46
50
47
-
Use yarn over npm
48
-
> Our team's official policy (for now) is: We only use [Yarn](https://yarnpkg.com/en/docs/install) as our official Node package manager, and so we request you to use Yarn instead of npm and commit `yarn.lock` file.
Remember to feel free to ask for help in our [Discord](https://discordapp.com/invite/dVnQ2Gf) rooms.
55
57
56
-
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)
57
58
58
-
### Running locally
59
+
### Running
59
60
60
-
1. Make sure you have [NodeJS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/en/docs/install) installed.
61
-
> Make sure you install node version 8 or above and check node version by running `node -v`
*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)*
83
+
84
+
#### Before submitting:
85
+
1. Fork the [repository](https://github.com/coderplex/coderplex).
86
+
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`
87
+
3. If you’ve fixed a bug or added code that should be tested, add tests!
88
+
4. Ensure that all test pass
89
+
```bash
90
+
$ yarn test
91
+
```
92
+
5. Run code formatters
93
+
```bash
94
+
$ yarn lint
95
+
```
96
+
6. Add and commit your code. Please give meaning full commit messages.
97
+
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.
98
+
8. Push the code to your fork.
99
+
9. Raise the pull request from your created branch to `master` branch of coderplex.
100
+
10. Take some time to give a brief description of the work you have done.
101
+
102
+
#### After submitting
103
+
1. Wait for all checks to pass in below section.
104
+
2. Your changes are deployed with a unique link `https://deploy-preview-xx--coderplex.netlify.com`. <br/>
105
+
*`- xx` is your pull request number.*
106
+
3. The core team will review your pull request and either merge it, request changes to it, or close it with an explanation.
107
+
108
+
##### Received a review request
109
+
- Work on the requested changes
110
+
- Push the changes as you did earlier, the pull request will automatically catch those and update itself.
@@ -91,7 +134,7 @@ Run the app in the same terminal session
91
134
```
92
135
*Make sure you have [curl](https://curl.haxx.se/) installed*
93
136
94
-
##### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows
137
+
###### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows
95
138
It comes with an [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades).
96
139
97
140
```bash
@@ -102,3 +145,6 @@ Use installed version
102
145
$ nvm use 8.9.1
103
146
```
104
147
Still facing problem this [article](https://medium.com/appseed-io/how-to-run-multiple-versions-of-node-js-with-nvm-for-windows-ffbe5c7a2b47) from [@skounis ](https://twitter.com/skounis) explain in details.
148
+
149
+
##### 2. Local host occupied
150
+
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.
0 commit comments