30 lines
1.2 KiB
Markdown
30 lines
1.2 KiB
Markdown
# 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.
|
|
|
|
<div style="text-align: center">
|
|
<h4>Report vulnerabilities <a href="https://github.com/ElBe-Development/logging-rs/security/advisories/new">here</a></h4>
|
|
</div>
|
|
|
|
## 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.
|
|
3. Implement your changes
|
|
4. Test your changes. Run `cargo fmt`, `cargo check` and `cargo clippy` to verify it works.
|
|
5. Create a pull request from your fork.
|
|
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!
|