Please read these guidelines before contributing to VaultSharp:
You can start a discussion thread on GitHub Discussions linked with this library found at pyshamir Discussions
GitHub issues are only for reporting bugs and feature requests, not questions or help.
If you find a bug in the source code or a mistake in the documentation, you can help by submitting an issue to the GitHub Repository. Even better you can submit a Pull Request with a fix.
When submitting an issue please include the following information:
- A description of the issue which includes the pyshamir version and Python version
- The exception message
- If possible, please include code that reproduces the issue. DropBox or GitHub's Gist can be used to share large code samples, or you could submit a pull request with the issue reproduced in a new test.
The more information you include about the issue, the more likely it is to be fixed!
When submitting a pull request to the GitHub Repository make sure to do the following:
- Please adhere to the existing coding pattern in the project. It should be straight-forward to absorb.
- Ensure that the unit test coverage is more than 80%
- Write appropriate code samples in the documentation. (README.md)
- Add the summary of the issue in the changelog
Read GitHub Help for more details about creating pull requests.
Thank you for submitting your contributions to this project.
By signing this CLA, you agree that the following terms apply to all of your past, present and future contributions to the project.
You hereby represent that all present, past and future contributions are governed by the MIT License copyright statement.
This entails that to the extent possible under law, you transfer all copyright and related or neighboring rights of the code or documents you contribute to the project itself or its maintainers. Furthermore you also represent that you have the authority to perform the above waiver with respect to the entirety of you contributions.
To the fullest extent permitted under applicable law, you hereby waive, and agree not to assert, all of your “moral rights” in or relating to your contributions for the benefit of the project.
If your Contribution includes or is based on any source code, object code, bug fixes, configuration changes, tools, specifications, documentation, data, materials, feedback, information or other works of authorship that were not authored by you (“Third Party Content”) or if you are aware of any third party intellectual property or proprietary rights associated with your Contribution (“Third Party Rights”), then you agree to include with the submission of your Contribution full details respecting such Third Party Content and Third Party Rights, including, without limitation, identification of which aspects of your Contribution contain Third Party Content or are associated with Third Party Rights, the owner/author of the Third Party Content and Third Party Rights, where you obtained the Third Party Content, and any applicable third party license terms or restrictions respecting the Third Party Content and Third Party Rights. For greater certainty, the foregoing obligations respecting the identification of Third Party Content and Third Party Rights do not apply to any portion of a Project that is incorporated into your Contribution to that same Project.
You represent that, other than the Third Party Content and Third Party Rights identified by you in accordance with this Agreement, you are the sole author of your Contributions and are legally entitled to grant the foregoing licenses and waivers in respect of your Contributions. If your Contributions were created in the course of your employment with your past or present employer(s), you represent that such employer(s) has authorized you to make your Contributions on behalf of such employer(s) or such employer (s) has waived all of their right, title or interest in or to your Contributions.
To the fullest extent permitted under applicable law, your Contributions are provided on an "as is" basis, without any warranties or conditions, express or implied, including, without limitation, any implied warranties or conditions of non-infringement, merchantability or fitness for a particular purpose. You are not required to provide support for your Contributions, except to the extent you desire to provide support.
You acknowledge that the maintainers of this project are under no obligation to use or incorporate your contributions into the project. The decision to use or incorporate your contributions into the project will be made at the sole discretion of the maintainers or their authorized delegates.