You are very welcome to contribute to the project! Pull requests welcome, as well as issues or plain messages.
Respect the below and I will be happy to merge your work and credit you for it.
- Follow the style and conventions already in place.
- As always, write clean, easy-to-read code. Prefer being slightly more verbose and semantic than being "efficient" and terse, if such a choice is necessary. Write as if someone is going to contribute on top of your code base tomorrow without knowing you or your work.
- Follow importing by highest-level components at top, and detail-oriented components at bottom, as per:
- External package imports
- Entities
- Contracts
- Use cases or other high-level files
- Same-level files
- Frameworks
- Messages, errors, warnings (separated)
- Always include tests for additions or changes. Aim for 100% coverage, but set a minimum bar to cover at least the main functionality.
MikroLogshould ideally have total code coverage of 95% or more. Your contribution will affect that score, so aim to keep it high(er)! :) - It's encouraged to place any test data in the
testdata/folder. - Always check that all tests (including your new ones) are passing before making a pull request.
- Make sure to handle errors and do any relevant validation logic. Also always output meaningful, actionable messages/warnings/errors to the user.
- Avoid inlining messages, errors or warnings. Instead place those in the dedicated files for each of the mentioned concerns, and read them from there.
- Document your code with JSDoc at the start of your code.
- Add any inline comments as needed for anything that is not self-evident.
- Update the README with any user-facing changes, such as new CLI commands or arguments.