Thank you for your interest in contributing to slog4s. All contributions are welcome if they are consistent with the goals and guidelines of the project.
It is better to open an issue in the project and discuss your intention with project maintainers before you actually start implementing something. They can also give you tips on how to go about implementing it.
Please read the First Contributions Guide for general information about contribution to OSS projects.
The project can be built and tested using simple SBT command:
sbt testThere is also an extra command called check which you should use to check your code before you submit a PR:
sbt checkSome of the reported problems can be automatically fixed by fix:
sbt fixThe project contains compiled documentation which is located in site/docs. Please do update it with your changes and recompile it to check that everything is fine using the following command:
sbt site/makeMdocThe project uses Conventional Commits specification to have clear Git history and help with semantic versioning. Please read the specification and follow it (or look at already existing history for inspiration) if you commit into the project.