Skip to content
This repository was archived by the owner on Sep 1, 2020. It is now read-only.

Commit 133b2dd

Browse files
committed
Add contibuting.md
1 parent 0449827 commit 133b2dd

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing
2+
First off, thanks for taking the time to contribute.
3+
4+
Please read https://reactjs.org/ and the Code of Conduct before opening an issue.
5+
6+
### Found a bug?
7+
8+
##### Before Submitting A Bug Report
9+
- Please read the [API documentation](https://github.com/vkbansal/react-contextmenu#api) thoroughly
10+
- Perform a [cursory search](https://github.com/vkbansal/react-contextmenu/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.
11+
12+
##### Submiting a (good) bug report
13+
14+
- **Use a clear and descriptive title** for the issue to identify the problem.
15+
- **Provide specific examples to demonstrate the steps**. Include links to CodePen/JS Bin or GitHub projects, or copy/paste-able snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
16+
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
17+
- **Explain which behavior you expected to see instead and why.**
18+
- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
19+
20+
### Proposing New or Changed API?
21+
22+
Please provide thoughtful comments and some sample code. Proposals without substance will be closed.
23+
24+
### Making a Pull Request
25+
26+
Pull requests need only the 👍 of admin or two or more collaborators to be merged.
27+
28+
##### Linting and Tests
29+
30+
- All the commits must pass lint and tests.
31+
- All commits that fix bugs or add features need a test.
32+
33+
You can run lint + tests via:
34+
35+
```
36+
npm test
37+
```
38+
39+
If you just want to run lint:
40+
41+
```
42+
npm run lint
43+
```
44+
45+
If you just want to run all tests:
46+
47+
```
48+
npm run test:only
49+
```
50+
51+
##### Development
52+
53+
You can start webpack & dev server that watches for changes and build the examples via:
54+
55+
```
56+
npm start
57+
```
58+
59+
60+

0 commit comments

Comments
 (0)