Thank you for wanting to contribute to the project!
You are expected to adhere to the code of conduct in comments, messages and submissions.
Contributions are welcome in many forms. Please be aware that response times may vary.
Please submit a pull request with your changes. See Code submission below for guidelines.
If you have any questions about how to use inkling, please open an issue with the Question template. This helps us identify where people run into problems and how to improve the usability or documentation.
Likewise, if you have any suggestions about improving the software, please open an issue with the Suggestion template. We are always interested in knowing how to make it better and easier to use.
Finally, if you have encountered an issue or bug with running the software, please file an issue report. Use the Issue template.
By submitting a pull request you agree to the third-party license agreement.
Before submitting your request, please follow these steps:
- If functionality is added or modified, add and modify tests as suitable. Tests should cover edge cases.
- Ensure that all tests pass by running
cargo test --all-features. - Reformat the code by running
cargo fmtwith default settings (if this touches more than your new code, please commit those changes separately).
Please don't hesitate to contact us or open an issue if you have questions.
Before submitting a pull request with a major change (and preferably before spending the time to write the code), please open an issue where we can discuss the change in more detail and whether compensation or recognition as a main developer is appropriate.
Where the line between a minor and major change is drawn is unclear. If you have any questions about this, please contact us.