Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.82 KB
Raw

How to contribute to this project

Did you find a bug? You want to have a feature implemented? You made code better? Please follow the instructions below on how to contribute to this project.

Notes

Please do not report an issue of pull request if the issue is a security vulnerability. There is a different way to report such issues. Issues or pull requests about a vulnerability will be removed.

Report vulnerabilities here

Contributing

For any issues or proposals, open an issue. If you already wrote your proposed change(s), please open an issue and a pull request. See below for making changes on your own.

Making changes on your own

  1. Create a new issue with a summary of your proposed changes and more.
  2. Fork the repository from your issue branch, for issue 8, it would be issue-8, etc.
  3. Implement your changes. Please follow ILEP (list here) 002, 003, 007, 008 and 009 and the rust API guidelines. The API guidelines only apply to rust code, but you should not need to follow rule C-QUESTION-MARK (use .unwrap()) or C-LINK (as we are using our own documentation generator).
  4. Test your changes. Run just f and just l to verify it works.
  5. Create a pull request from your fork to the branch you forked from.
  6. If it gets accepted, your changes will be in the next release.

To everyone who has reported issues, proposed changes or just helped with peoples questions: Thank you!