Thank you so much for becoming a Locutus contributor!
Even if you have write access, all code changes should be done via a pull request. This way we can peer-review, and also Travis CI can check if the code adheres to our policies before merging it in.
Here are a few pointers that could save us from disappointment, we'll keep it brief:
- By submitting a Pull Request you are giving Locutus permission to distribute your code under the MIT License.
- Please adhere to our updated coding standards. Use
npm run lint
to check. Code should:
- Follow the JavaScript Standard Style
- Not have lines longer than 100 chars
- Use
//
for comments instead of/*
- Avoid using lengthy (3+ words) comments on the same line as code
- Please credit yourself in the function's header-comment:
(original by|reimplemented by|improved by|parts by|bugfixed by|revised by|input by): Your Name (http://your.url)
- If you are fixing bad behavior, please add an
example
that would fail before your patch, and aresult
that passes after your patch, to the function's header-comment - Sometimes we place
for
insideif
for performance reasons, even though the code could be half the size if we did this the other way around.