We thank you for taking the time and considering contributing to our project! This document details how to do so.
Please be respectful in all your communications, in pull requests and issues, to all fellow members of the community.
- Fork the repository: This creates a copy of the repository in your account.
- Clone the repository: This downloads the repository to your local machine.
- Create a branch: This isolates your changes into a separate branch.
- Make your changes: Add, edit, or delete files as necessary.
- Commit your changes: Make a commit to save your changes and write a brief summary of what you did.
- Push your changes: Send your changes to your repository on GitHub.
- Create a pull request: Request that we review your changes and pull them into our repository.
We require that all commits would be signed to certify that the contributor has the rights to their contribution and agrees to the terms of our license, as stated below.
To sign your commit, use git commit -s -m "your commit message".
By contributing, you agree that your contributions will be licensed under the license of the project defined at LICENSE.
Additionally, by providing your contribution, you agree that Fireblocks Ltd. ("Fireblocks") has the right to use and exploit your contribution as they see fit, without any restrictions or additional consent. This does not grant Fireblocks exclusive rights to your contributions but allows Fireblocks to use your contributions in any way, whether publicly or privately, without any liabilities or restrictions.
For anything related to the security of the library or bug bounty program please see SECURITY.
If you have questions or need additional guidance please open a GitHub issue.
Thank you.