Skip to content

Commit 0979ade

Browse files
committed
🚀 added contributing guide and PR Template
1 parent 73852c2 commit 0979ade

2 files changed

Lines changed: 89 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--
2+
Please make sure you are familiar with and follow the instructions in the
3+
contributing guidelines (found in the CONTRIBUTING.md file).
4+
5+
Please fill out the information below to expedite the review and (hopefully)
6+
merge of your pull request!
7+
-->
8+
9+
<!-- Is it a Bug fix, feature, docs update, ... -->
10+
**What kind of change does this PR introduce?**
11+
12+
<!-- You can also link to an open issue here -->
13+
**What is the current behavior?**
14+
15+
<!-- if this is a feature change -->
16+
**What is the new behavior?**
17+
18+
19+
<!-- Have you done all of these things? -->
20+
**Checklist**:
21+
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
22+
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
23+
- [ ] Documentation
24+
- [ ] Tests
25+
- [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
26+
- [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions -->
27+
28+
<!-- feel free to add additional comments -->
29+
30+
<!-- Thank you for contributing! -->

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## Setting Up the project locally
2+
3+
To install the project you need to have `yarn` and `node`
4+
5+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork:
6+
7+
```
8+
# Clone your fork
9+
git clone https://github.com/<your-username>/react-polling.git
10+
11+
# Navigate to the newly cloned directory
12+
cd react-polling
13+
```
14+
15+
2. `yarn` to install dependencies
16+
3. `yarn build` to build the UMD and ES bundle of the app
17+
18+
19+
> Tip: Keep your `master` branch pointing at the original repository and make
20+
> pull requests from branches on your fork. To do this, run:
21+
>
22+
> ```
23+
> git remote add upstream https://github.com/vivek12345/react-polling.git
24+
> git fetch upstream
25+
> git branch --set-upstream-to=upstream/master master
26+
> ```
27+
>
28+
> This will add the original repository as a "remote" called "upstream,"
29+
> Then fetch the git information from that remote, then set your local `master`
30+
> branch to use the upstream master branch whenever you run `git pull`.
31+
> Then you can make all of your pull request branches based on this `master`
32+
> branch. Whenever you want to update your version of `master`, do a regular
33+
> `git pull`.
34+
35+
## Submitting a Pull Request
36+
37+
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.
38+
39+
Also, make sure to run the tests and lint the code before you commit your changes.
40+
41+
```
42+
yarn test
43+
yarn lint
44+
```
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+
```
54+
yarn add-contributor
55+
```
56+
57+
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
58+
59+
Thank you for taking the time to contribute! :+1:

0 commit comments

Comments
 (0)