|
| 1 | +Thanks for contributing, you rock! |
| 2 | + |
| 3 | +If you use our code, it is now *our* code. |
| 4 | + |
| 5 | +- [Think You Found a Bug?](#bug) |
| 6 | +- [Proposing New or Changed API?](#api) |
| 7 | +- [Issue Not Getting Attention?](#attention) |
| 8 | +- [Making a Pull Request?](#pr) |
| 9 | +- [Development](#development) |
| 10 | +- [Hacking](#hacking) |
| 11 | + |
| 12 | +<a name="bug"/> |
| 13 | +## Think You Found a Bug? |
| 14 | + |
| 15 | +Please provide a test case of some sort. Best is a pull request with a failing test. Next is a link to CodePen/JS Bin or repository that illustrates the bug. Finally, some copy/pastable code is acceptable. |
| 16 | + |
| 17 | +<a name="api"/> |
| 18 | +## Proposing New or Changed API? |
| 19 | + |
| 20 | +Please provide thoughtful comments and some sample code. Proposals without substance will be closed. |
| 21 | + |
| 22 | +<a name="attention"/> |
| 23 | +## Issue Not Getting Attention? |
| 24 | + |
| 25 | +If you need a bug fixed and nobody is fixing it, it is your responsibility to fix it. Issues with no activity for 30 days may be closed. |
| 26 | + |
| 27 | +<a name="pr"/> |
| 28 | +## Making a Pull Request? |
| 29 | + |
| 30 | +Do not include the results of `npm run build` / `npm run build-npm` / `npm run build-min`. This is done at the release cycle by the maintainer when publishing a new version. |
| 31 | + |
| 32 | +### Tests |
| 33 | + |
| 34 | +All commits that fix bugs or add features need a test. |
| 35 | + |
| 36 | +`<blink>`Do not merge code without tests.`</blink>` |
| 37 | + |
| 38 | +### Changelog |
| 39 | + |
| 40 | +All commits that change or add to the API must be done in a pull request that also: |
| 41 | + |
| 42 | +- Adds an entry to `CHANGES.md` with clear steps for updating code for changed or removed API |
| 43 | +- Updates examples |
| 44 | +- Updates the docs |
| 45 | + |
| 46 | +## Development |
| 47 | + |
| 48 | +- `npm test` starts a karma test runner and watch for changes |
| 49 | +- `npm run examples` starts a webpack dev server that will watch for changes and build the examples |
| 50 | + |
| 51 | +## Hacking |
| 52 | + |
| 53 | +The best way to hack on the router is to run examples. |
| 54 | + |
| 55 | +This guidelines are inspired by [reactjs/react-router](https://github.com/reactjs/react-router/blob/master/CONTRIBUTING.md) |
0 commit comments