Contribution Guidelines

Getting involved

Before getting started, we can't recommend enough reading the contribution guidelines for Dotanuki Labs projects.

This document augments these recommendations with specifics ones for this project!

When looking for something easy to contribute, we can recommend checking good first issues in our issue tracker.

Reporting (issues)

Reporting bugs

This project uses that standard recommendations for reporting bugs in Dotanuki Labs.

In particular, all bugs are tracked as GitHub issues with the bug label applied.

When reporting a bug, ensure you follow the provided template paying especial attention to instructions on how to reproduce it.

WARNING

Bug reports that can't be reproduced may be marked as wontfix and closed.

We value a lot bug reports! We'll reply to you up to 24h after a bug is reported. For bugs we manage to reproduce, we'll release a new version of this project as soon we have a fix in place!

Reporting vulnerabilities

WARNING

DO NOT raise GitHub issues to report a security vulnerabilities.

This project uses the standard Security Policies for Dotanuki Labs. Please check them out.

Code Contributions (Pull Requests)

NOTE

For non-Dotanuki members, we'll only accept contributions from forked repositories

General procedure

• Ensure you've read our development guidelines
• Fork this project
• Ensure you have a proper running environment for your fork, e.g. running unit tests locally

./krabby.sh tests

• Code your changes 🔥
• Use our krabby tasks to verify what we execute on CI
• Raise your Pull Request 🚀
• Fill the description with our pull request template
• Ensure you've your PR linked with a proper issue

Fixing bugs

When fixing an existing bug:

• Describe why your fix works as intended
• If applicable, ensure you've added a test case covering the fixed bug

Adding new functionality

When adding a new feature:

• Describe briefly your solution
• Ensure you've added tests covering use cases for the functionality
• Consider using inlay Pull Request comments to highlight specific implementation details

License

Please note that all code contributed by you will follow the MIT license without any additional terms.