Thank you for wanting to contribute to the project! # Code of conduct You are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md) in comments, messages and submissions. # Contributions Contributions are welcome in many forms. Please be aware that response times may vary. ## Minor patches Please submit a pull request with your changes. See [Code submission](#code-submission) below for guidelines. ## Questions 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. ## Suggestions 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. ## Issues Finally, if you have encountered an issue or bug with running the software, please file an issue report. Use the `Issue` template. # Code submission By submitting a pull request you agree to the [third-party license agreement](LICENSE-APACHE.txt). Before submitting your request, please follow these steps: 1. If functionality is added or modified, add and modify tests as suitable. Tests should cover edge cases. 2. Ensure that all tests pass by running `cargo test --all-features`. 3. Reformat the code by running `cargo fmt` with 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. # Major patches 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](mailto:pjohansson@fastmail.com).