Contribute to the
PurpleKrypt Project
We appreciate your interest in contributing to PurpleKrypt! Whether you're interested in improving the cryptographic implementations,
improving the graphical tool, or extending the documentation, your contributions will help make this project better.
Contributions can range from fixing simple typos and improving documentation to conducting advanced tasks like
auditing cryptographic implementations, optimizing code efficiency, and adding new features. Every contribution
is valuable, and we welcome contributions of all levels.
Please follow the instructions below, and we look forward to collaborating with you!
Contributing to PurpleKrypt Graphical Tool
We welcome contributions to PurpleKrypt Graphical Tool, Documentations, and the PurpleKrypt Website.
We truly value the time and effort of all contributors. Whether it's bug fixes,
UI improvements, code efficiency enhancements, new features, or any other improvements you believe would enhance the project,
we are open to contributions of all kinds. From small tweaks to larger enhancements, we appreciate the creativity and effort
of each contributor. The process for contributing is straightforward, as outlined below (Standard GitHub Contribution):
1. Create an Issue (if none exists):
If the bug or feature you want to work on isn’t already listed as an issue, please create one. Be sure to provide
a clear description of the bug or feature request, including any relevant context or details.
2. Comment on the Issue:
Before you begin working, comment on the issue to let us know you are planning to tackle it. This helps ensure
that no one else is working on the same task. For example, you can comment, “I’ll work on fixing this bug” or
“I’ll implement this feature.”
3. Fork the Repository:
Once the issue is ready, fork the repository to create your own copy. This will allow you to freely make changes
to the code in your fork, whether it’s fixing bugs, improving features, or adding new functionality.
4. Make Your Changes:
Now, you can freely work on the task. Be sure to follow the project’s coding style, write tests for any new
functionality, and keep your commits focused and descriptive.
5. Submit a Pull Request (PR):
Once you're ready to submit your work, open a pull request (PR) from your fork to the main repository. In your PR
description, provide a clear summary of what your changes do, why they’re beneficial, and reference the issue number
you’re working on. This allows us to track the changes and see the connection to the original issue.
6. Review and Merge:
After you submit your PR, the project maintainers will review it. We’ll provide feedback or approve the PR. Once
everything looks good, we’ll merge your changes into the main codebase.
