Welcome to our GitHub repository! We appreciate your interest in contributing to our project. We value the collaborative spirit of the open-source community and would love to have your contributions. This document outlines the guidelines to help you get started. For more detailed information, please refer to our wiki section.
- Fork the repository develop branch to your GitHub
account.
main branch tries to mirror the CRIPT Pypi package, develop branch has all the latest developments waiting for release
- Create a new branch in your forked repository. Choose a descriptive name that summarizes your contribution.
- Make the necessary changes or additions to the codebase.
- Test your changes thoroughly to ensure they don't introduce any issues.
- Commit your changes with a clear and concise commit message.
- Push the changes to your forked repository.
- Open a pull request (PR) in our repository to propose your changes.
Please be sure to merge all of your incoming changes to the develop branch, we only update the main branch when going to make a release by merging develop branch into main. For more information, please refer to repository guidelines wiki and deployment wiki
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists, and the discussion might inform you of workarounds readily available.
We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario using the custom issue template. Please stick to the issue template.
Unfortunately, we are not able to investigate/fix bugs without a minimal reproduction scenario, so if we don't hear back from you, we may close the issue.
Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort. If you do not find a related issue or PR, go ahead.
When submitting a pull request, please make sure to:
- Clearly describe the purpose of your PR.
- Include any relevant information or context that helps us understand your changes.
- Make sure your changes adhere to our coding style and guidelines.
- Test your changes thoroughly and provide any necessary documentation or test cases.
- Ensure your PR does not include any unrelated or unnecessary changes.
- All CI must pass before a PR can be approved and merged into the code base.
For more in-depth information about our project, development setup, coding conventions, and specific areas where you can contribute, please refer to our wiki section. It contains valuable resources and documentation to help you understand our project better.
We encourage you to explore the wiki before making contributions. It will provide you with the necessary background knowledge and help you find areas where your expertise can make a difference.
If you have any questions, concerns, or need clarification on anything related to the project or your contributions, feel free to reach out to us. You can use the GitHub issue tracker or the Discussion channels.
We expect all contributors to adhere to our code of conduct, which ensures a safe and inclusive environment for everyone. Please review our code of conduct before making contributions.
Thank you for considering contributing to our project! We appreciate your time and effort in making it better.