Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 8ee6ceb

Browse files
committed
update contribution guidelines
1 parent e0cd6e5 commit 8ee6ceb

File tree

2 files changed

+23
-31
lines changed

2 files changed

+23
-31
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
1-
## Contribution guidlines
1+
# Contribution guidlines
22

3-
### Testing
3+
We welcome pull requests from freeCodeCamp campers (our students) and seasoned JavaScript developers alike! Follow these steps to contribute:
44

5-
#### Test deploy
5+
1. Find an issue that needs assistance by searching for the [Help Wanted](https://github.com/coderplex/coderplex/labels/help%20wanted) tag.
66

7+
1. Let us know you are working on it by posting a comment on the issue.
78

8-
* Install [now-cli](https://zeit.co/now)
9-
```bash
10-
$ npm i -g now
11-
```
12-
* Run **now** inside the project root directory
13-
```bash
14-
$ now
15-
```
16-
* After the app is deployed. [Alias](https://zeit.co/docs/features/aliases) your generated link to *coderplex-pr-XX.now.sh*
17-
```bash
18-
$ now alias url coderplex-pr-XX
19-
```
20-
> url = generated link to website when `now` was run
9+
1. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue.
2110

22-
> XX = Opened pull request number
11+
Remember to feel free to ask for help in our [Discord](https://discordapp.com/invite/dVnQ2Gf) rooms.
2312

13+
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)
14+
15+
## Running this project locally
16+
17+
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
18+
> Make sure you install node version 8 or above and check node version by running `node -v`
19+
1. Then clone this repo
20+
```bash
21+
git clone [email protected]:coderplex/coderplex.git
22+
```
23+
1. `cd coderplex`
24+
1. `npm install`
25+
1. `npm run dev` to start local development server
26+
1. App opens at `localhost:3000`

README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,8 @@ This project mainly uses
1212
- [Next.js](https://github.com/zeit/next.js/)
1313
- [Semantic UI React](http://react.semantic-ui.com/introduction)
1414

15-
## Demo
15+
### [Join our community here](https://www.coderplex.org)
1616

17-
[https://coderplex.org](https://coderplex.org)
17+
## Contributing
1818

19-
## Running Locally
20-
21-
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
22-
> Make sure you install node version 8 or above and check node version by running `node -v`
23-
1. Then clone this repo
24-
```bash
25-
git clone [email protected]:coderplex/coderplex.git
26-
```
27-
1. `cd coderplex`
28-
1. `npm install`
29-
1. `npm run dev` to start local development server
30-
1. Open app at `localhost:3000`
19+
We welcome pull requests from coderplex hackers (our students) and seasoned JavaScript developers alike! Please follow [these steps](CONTRIBUTING.md) to contribute.

0 commit comments

Comments
 (0)