Skip to content

Commit 2ffa8ac

Browse files
author
Erin Doyle
committed
Added a CONTRIBUTING page and linked to it from the README.
1 parent c715c45 commit 2ffa8ac

2 files changed

Lines changed: 78 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributing to react-a11y
2+
3+
## Setting up the workspace
4+
5+
Before you can submit a Pull Request you'll need to do the following:
6+
7+
1. Fork the repository on GitHub
8+
9+
2. Clone your fork
10+
11+
```bash
12+
git clone https://github.com/<your_username>/react-a11y.git
13+
cd react-a11y
14+
```
15+
16+
3. Install for development
17+
18+
```bash
19+
npm install
20+
```
21+
22+
## Workflow
23+
24+
Lint the code:
25+
26+
```bash
27+
npm run lint
28+
```
29+
30+
Run the tests:
31+
32+
```bash
33+
npm run mocha // run tests using mocha only
34+
npm run karma // run tests using karma only
35+
npm run test // run tests using both mocha and karma
36+
```
37+
38+
Build the code:
39+
40+
```bash
41+
npm run build
42+
```
43+
44+
## Making changes
45+
46+
1. Checkout a new branch and name it accordingly to what you intend to do
47+
48+
```bash
49+
git checkout -b <branch_name>
50+
```
51+
52+
2. Make your intended changes, being sure to run the tests and lint the code.
53+
54+
## Submitting a Pull Request
55+
56+
1. Commit your changes (please make commits small and commit messages descriptive):
57+
58+
```bash
59+
git commit -m "..."
60+
```
61+
62+
2. Push to _your_ github repo:
63+
```bash
64+
git push origin <branch_name>
65+
```
66+
67+
3. Go to the GitHub page and click "New Pull request".
68+
4. Write a good description of the change.
69+
70+
After sending a pull request, other developers will review and discuss your change. Please address all the comments. Once everything is all right, one of the maintainers will merge your changes in.
71+
72+
## Additional Resources
73+
* [GitHub pull request help](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/)

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,12 @@ These are some plans I've dreamt up for `react-a11y`:
232232
maintenance for me, since poeple can build their own, and it
233233
would make `react-a11y` a formidable validation tool.
234234
- [ ] **create a nice project page** with documentation, because
235-
that is what poeple like these days.
235+
that is what people like these days.
236236
- [ ] create filtering options based on rule outputs like `affects`
237+
238+
## Contributing
239+
240+
Interested in contributing? Great! Look here for more info: [CONTRIBUTING.md](https://github.com/romeovs/react-a11y/blob/master/CONTRIBUTING.md).
237241
238242
[react-a11y]: https://github.com/reactjs/react-a11y
239243
[eslint]: http://eslint.org

0 commit comments

Comments
 (0)