All contributions are appreciated, as long as they keep in mind these basic rules:
- Check if an issue for your bug/suggestion already exists.
- Please provide a clear description of the bug/suggestion.
- Always include a minimal code sample.
- If you're up to it, try contributing the fix/feature yourself by opening a pull request.
- Be nice ❤️
- Pull requests must be based-on and targeted-to the
main
branch. - Tests must be added or updated (if applicable).
- Do not introduce breaking changes, except when:
- This behavior relies on a bug.
- There's another very good reason to.
- Splitting your contribution in multiple commits is highly encouraged, as long as each of them represents a "unit of work". Please squash all 'intermediate' commits before opening your pull request.
- Be nice ❤️
- Use tabs instead of spaces.
- Prefer
'
over"
. - Always keep two empty lines between the last import statement and actual code.
- Always use semicolons, except for:
- Import declarations.
- Multi-line function invocations, for example a function invocation with an anonymous function as parameter.
- Only use
any
when absolutely necessary. - The return type of functions should be declared explicitly, except for small inner functions.
- In tests, when the exact 'location of invocation' is not immediately obvious, put it on a new line to avoid "parentheses hell".