azures04/crafatar
1
0
Fork 0
mirror of https://github.com/azures04/crafatar.git synced 2026-03-21 23:41:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

add contribution guidelines

Browse Source
This commit is contained in:
jomo 2015-02-03 23:09:20 +01:00
parent 7162562cdc
commit ecc8dc5e23
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,22 @@
# Contribution guidelines
## For Issues:
0. Check for **similar issues** first!
0. Provide as **many details** as possible
## For Pull Requests:
0. Indent using **2 spaces**
0. Use **double quotes** for strings
* Exception: `'"'`
0. Write only **one expression per line**
* Bad: `foo(); bar();`
0. Write **valid JavaScript**, a code linter is recommended!
0. **Explain code** that is not obvious (comment above)
0. If you add new functions, **add documentation** (comment above)
* Wrap function arguments in `+` signs (e.g. `the +type+ is used for…`)
0. If you add new functions, **add tests** (test/test.js)
0. Run **tests** (`npm test`)
0. Make sure as much of your code as possible is **covered by tests**
0. Double check that your pull request is **awesome** :)