Contributions are always welcome. This guide will become more detailed as is necessarily prudent. For now, the generalities to follow when contributing to this library are:
- Please do not push commented code (a.k.a., Hot Code in some circles). This is code that if uncommented could potentially work. Code in comments for the sake of example are encouraged as a form of documentation.
- If in your travels you find Hot Code, please remove it with an independent commit message such as Removed commented code just in case we need to find it later (i.e., it was scaffolding for a future feature that got paused but accidentally pushed).
- Always run
npm run lintbefore submitting merge requests (this runs TSLint). Fix any issues that arise, bearing in mind it does not lint Angular code (i.e., decorations like@Comment). - If necessary, use specific TSLint rule disable comments for that line (preferably). Use of this option must be justifiable beyond subjective arguments.
- Use of JSDoc comments is appreciated.
- If you have designed a large feature, please provide Markdown-formatted document explaining it.
- Karma Tests would be great... Thanks for volunteering. :thumbs-up:
It should go without saying, but we will anyway, that we are expecting the contribution to be tested already (i.e., it was able to transpile and run for that feature).
Thanks for your contribution!