We welcome contributions to the Quantum Cryptographic Toolkit! Please follow these guidelines to help us maintain and improve the project.
-
Fork the repository: Create your own fork of the project by clicking the "Fork" button on the repository page.
-
Clone your fork: Clone your forked repository to your local machine.
git clone https://github.com/dkrizhanovskyi/quantum_cryptographic_toolkit.git cd quantum_cryptographic_toolkit -
Create a new branch: Create a new branch for your contribution.
git checkout -b my-feature-branch
-
Make your changes: Implement your feature, fix bugs, or improve documentation.
-
Run tests: Ensure that your changes pass all tests.
cargo test -
Commit your changes: Commit your changes with a clear and descriptive commit message.
git add . git commit -m "Add my new feature"
-
Push to your fork: Push your changes to your fork on GitHub.
git push origin my-feature-branch
-
Create a pull request: Create a pull request to the original repository. Provide a detailed explanation of your changes and why they should be merged.
- Follow the Rust language coding conventions.
- Keep your code simple and readable.
- Document your code using Rust documentation comments (
///).
If you encounter any issues, please open an issue on the GitHub repository and provide detailed information about the problem.