Skip to content

Commit 826aac7

Browse files
committed
update contributing
1 parent 9f6290f commit 826aac7

1 file changed

Lines changed: 44 additions & 14 deletions

File tree

CONTRIBUTING.md

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,49 @@
1-
## Tests
1+
Thanks for contributing, you rock!
2+
3+
If you use our code, it is now *our* code.
4+
5+
Please read https://rackt.org/ and the Code of Conduct before opening an
6+
issue.
7+
8+
- [Think You Found a Bug?](#bug)
9+
- [Proposing New or Changed API?](#api)
10+
- [Issue Not Getting Attention?](#attention)
11+
- [Making a Pull Request?](#pr)
12+
- [Development](#development)
13+
- [Hacking](#hacking)
14+
15+
<a name="bug"/>
16+
## Think You Found a Bug?
17+
18+
Please provide a test case of some sort. Best is a pull request with a
19+
failing test. Next is a link to codepen/jsbin or repository that
20+
illustrates the bug. Finally, some copy/pastable code is acceptable.
21+
22+
If you don't provide a test case, the issue will be closed.
23+
24+
<a name="api"/>
25+
## Proposing New or Changed API?
26+
27+
Please provide thoughtful comments and some sample code. Proposals
28+
without substance will be closed.
29+
30+
<a name="attention"/>
31+
## Issue Not Getting Attention?
32+
33+
If you need a bug fixed and nobody is fixing it, it is your
34+
responsibility to fix it. Issues with no activity for 30 days may be
35+
closed.
36+
37+
<a name="pr"/>
38+
## Making a Pull Request?
39+
40+
### Tests
241

342
All commits that fix bugs or add features need a test.
443

5-
`<blink>` Do not merge code without tests.`</blink>`
44+
`<blink>`Do not merge code without tests.`</blink>`
645

7-
## Changelog
46+
### Changelog
847

948
All commits that change or add to the API must be done in a pull request
1049
that also:
@@ -14,22 +53,13 @@ that also:
1453
- Updates examples
1554
- Updates the docs
1655

17-
## API Deprecation
18-
19-
Introduce new API in minor versions, remove old APIs in major versions.
20-
21-
For example, if the current version is 2.3 and we change `<Router/>` to
22-
`<Rooter/>`, the next release will be 2.4 that contains both APIs but using
23-
`<Router/>` would log a warning to the console. When 3.0 is released,
24-
`<Router/>` would be completely removed.
25-
26-
### Development
56+
## Development
2757

2858
- `npm test` will fire up a karma test runner and watch for changes
2959
- `npm start` fires up a webpack dev server that will watch
3060
for changes and build the examples
3161

32-
### Hacking
62+
## Hacking
3363

3464
The best way to hack on the router is to symlink it into your project
3565
using [`npm link`](https://docs.npmjs.com/cli/link). Then, use `npm run watch`

0 commit comments

Comments
 (0)