qadapt/CONTRIBUTING.md

1.0 KiB

Contributing

If you're interested in assisting with development, here are the best ways to help:

Bug Reports

While this repository has automated testing in place, testing is no replacement for real-world usage. If you have questions about what behavior should be, please open an issue on Github.

Feature Requests

The work of coding is never finished. If you have ideas on how to make this code better for the future, please open an issue on Github.

Writing code to implement the feature isn't mandatory (though is appreciated), and there are no bad suggestions.

Documentation/Examples

To make this project easy to use, additional documentation and usage examples are greatly appreciated. Please also feel free to report typos and other documentation clarity errors.

Pull Requests

Thanks for your contribution! To assist expediently merging your code, please ensure the following have been run:

  • [] cargo fmt
  • [] make doc