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
+59-25Lines changed: 59 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -12,43 +12,50 @@ 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 web app takes place on Github itself. We use [Issues](https://github.com/coderplex/coderplex/issues) to track bugs, discuss ideas and work on improvements. [Projects](https://github.com/coderplex/coderplex/projects) are used to keep track of everything and is our project management app. 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 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.
16
16
17
-
## Contribution Prerequisites
18
-
### NodeJS
19
-
Minimum Node version v8.0.0+
17
+
## Development Workflow
18
+
19
+
We welcome pull requests from beginners and seasoned javaScript developers alike!
20
+
21
+
### Work on Issues
22
+
1. Find an issue that needs assistance by searching for the [open issues](https://github.com/coderplex/coderplex/labels/help-wanted).
23
+
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.
24
+
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.
25
+
26
+
27
+
### Proposing a Change
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.
30
+
31
+
### Prerequisites
32
+
##### 1. [NodeJS](https://nodejs.org/)
33
+
Minimum version v8.0.0+
20
34
```bash
21
35
To check node version
22
36
$ node -v
23
37
```
24
-
##### Using a Version Manager
25
-
If you prefer to keep LTS version or face problem updating your node then you might need a Node version manager tool.
26
-
27
-
###### [nvm](https://github.com/creationix/nvm) for Linux & OSX
###### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows
35
-
It comes with a [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades).
38
+
Any lower version than mentioned above may results in this [error](https://github.com/coderplex/coderplex/issues/100).
36
39
40
+
> If you face problem updating your node then you might need a Node version manager tool. [Follow here]()
37
41
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)
38
46
39
-
We welcome pull requests from hackerspace members (our students) and seasoned JavaScript developers alike! Follow these steps to contribute:
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.
40
49
41
-
1. Find an issue that needs assistance by searching for the [Help Wanted](https://github.com/coderplex/coderplex/labels/help-wanted) tag.
1. Let us know you are working on it by posting a comment on the issue.
44
-
45
-
1. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue.
46
53
47
54
Remember to feel free to ask for help in our [Discord](https://discordapp.com/invite/dVnQ2Gf) rooms.
48
55
49
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)
50
57
51
-
## Running this project locally
58
+
###Running locally
52
59
53
60
1. Make sure you have [NodeJS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/en/docs/install) installed.
54
61
> Make sure you install node version 8 or above and check node version by running `node -v`
@@ -61,10 +68,37 @@ Working on your first Pull Request? You can learn how from this *free* series [H
61
68
1. `npm run dev` to start local development server
62
69
1. App opens at `localhost:3000`
63
70
64
-
**Note:**
65
-
> So 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.
*Make sure you have [curl](https://curl.haxx.se/) installed*
93
+
94
+
##### [nvm-windows](https://github.com/coreybutler/nvm-windows) for Windows
95
+
It comes with an [installer](https://github.com/coreybutler/nvm-windows#installation--upgrades).
96
+
97
+
```bash
98
+
Install particular version
99
+
$ nvm install 8.9.1
100
+
101
+
Use installed version
102
+
$ nvm use 8.9.1
103
+
```
104
+
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.
0 commit comments