## Contributing guidelines Here are some guidelines to follow when contributing to this project. ### Code of Conduct We are following the [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct). Please read it before contributing and follow it through your interactions with the project. ### Issues If you find a bug or have a feature request, please open an issue. Also, if you have a fix for a bug or a feature request, please open an issue to discuss it before opening a pull request. ### Pull Requests Pull requests are welcome! Please follow the following guidelines when opening a pull request: - Open an issue to discuss the changes you want to make before opening a pull request. This will help us discuss the changes and make sure that they are in line with the project's goals. - Make sure that your changes are in line with the project's goals [as stated in the README](goals). - You need to make your changes in a separate branch. You can name the branch whatever you want, but it should be descriptive of the changes you made. For example, if you are fixing a bug, you can name the branch `fix-bug-`. If you are adding a feature, you can name the branch `add-feature-`. - Make sure that your changes are well documented. This includes documenting your code and adding a description of your changes to the [changelog](changelog). - Make sure that your changes are well tested. This includes adding tests for your code and making sure that all tests pass before opening a pull request. You can run the tests using `cargo test`. - Make sure that your changes are formatted using `cargo fmt`. and that they pass `cargo clippy`. ### Commit Messages We are not following any specific commit message format. but please make sure that your commit messages are descriptive and explain the changes you made. ### Changelog Please add a description of your changes to the [changelog](changelog) when opening a pull request. This will help us keep track of the changes in each version of the program. We are following the [Keep a Changelog](keepachangelog) format. ### License By contributing to this project, you agree that your contributions will be licensed under the [MIT License](license). This is to make sure that the project remains open source and that everyone can use it. Please make sure that you agree with this before contributing. If you don't agree with this, please don't contribute to this project. (After all, you can always fork the project and make your own version of it, licensed under whatever license you want.) ### Removing your contributions Please before contributing, make sure that you want to contribute to this project and that you agree with the [license](license). We will not remove your contributions from the project after you contribute. If you don't agree with this, please don't contribute to this project. [changelog]: https://github.com/theawiteb/jwt-tui/blob/master/CHANGELOG.md [keepachangelog]: https://keepachangelog.com/en/1.0.0/ [license]: https://github.com/theawiteb/jwt-tui/blob/master/LICENSE [goals]: https://github.com/theawiteb/jwt-tui/blob/master/README.md#goals