Skip to content

Commit 00c2a8f

Browse files
authored
Create CONTRIBUTING.md
1 parent 4e57fd3 commit 00c2a8f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
## Issues
4+
5+
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
6+
7+
## Pull Requests
8+
9+
* Fork the repo and create your branch from master.
10+
* If you've added code that should be tested, add tests.
11+
* Ensure the test suite passes.
12+
13+
## Coding Style
14+
15+
* Avoid abbreviations.
16+
* TODO comments should indicate the responsible person (e.g. `// TODO(john): comment goes here`)
17+
* For the sake of simplicity, we're using only TODO comments, no FIXMEs, etc.

0 commit comments

Comments
 (0)