Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 879 Bytes

CONTRIBUTING.md

File metadata and controls

18 lines (13 loc) · 879 Bytes
Raw

I welcome contributions of any kind with open arms. That said, please do stick to some basics:

  • For code contributions:

    • Fix any cargo clippy warnings, using at least the default configuration.
    • Make sure your code is formatted using cargo fmt.
    • Keep any documentation up to date.
    • Please use conventional commit messages. This ensures your contributions are automatically included in the changelog.

  • For PRs:

    • Please open an issue or discussion beforehand. I'll accept most contributions, but it's best to make sure you're not working on something that won't get accepted :)

  • For issues:

    • Please provide as much information as you can - share your config, any logs, steps to reproduce...
    • If reporting an error, please ensure you use IRONBAR_LOG or IRONBAR_FILE_LOG set to debug.