Skip to content

Commit ff7ec34

Browse files
committed
docs(contributing): Adding CONTRIBUTING.md
1 parent 674f227 commit ff7ec34

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing
2+
3+
**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)
4+
5+
## Setting up the project locally
6+
7+
To install the project you need to have `npm` or `yarn` and `node`
8+
9+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork:
10+
11+
```
12+
# Clone your fork
13+
git clone https://github.com/<your-username>/react-semantic-ui-datepickers.git
14+
15+
# Navigate to the newly cloned directory
16+
cd react-semantic-ui-datepickers
17+
```
18+
19+
2. `npm install` or `yarn` to install dependencies
20+
3. `npm run storybook` or `yarn storybook` to start Storybook
21+
22+
> Tip: Keep your `master` branch pointing at the original repository and make
23+
> pull requests from branches on your fork. To do this, run:
24+
>
25+
> ```
26+
> git remote add upstream https://github.com/arthurdenner/react-semantic-ui-datepickers.git
27+
> git fetch upstream
28+
> git branch --set-upstream-to=upstream/master master
29+
> ```
30+
>
31+
> This will add the original repository as a "remote" called "upstream,"
32+
> Then fetch the git information from that remote, then set your local `master`
33+
> branch to use the upstream master branch whenever you run `git pull`.
34+
> Then you can make all of your pull request branches based on this `master`
35+
> branch. Whenever you want to update your version of `master`, do a regular
36+
> `git pull`.
37+
38+
## Submitting a Pull Request
39+
40+
Please go through existing issues and pull requests to check if somebody else is already working on it, we use `someone working on it` label to mark such issues.
41+
42+
Also, make sure to run the tests before you commit your changes:
43+
44+
`npm run test` or `yarn test`.
45+
46+
## Add yourself as a contributor
47+
48+
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
49+
50+
To add yourself to the table of contributors on the `README.md`, please use the
51+
automated script as part of your PR:
52+
53+
`npm run add-contributor` or `yarn add-contributor`
54+
55+
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
56+
57+
Thank you for taking the time to contribute! 👍

0 commit comments

Comments
 (0)