Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (30 loc) · 5.32 KB

CONTRIBUTING.md

File metadata and controls

55 lines (30 loc) · 5.32 KB

Bouncy Castle Contributing Guidelines

Thank you for contributing to Bouncy Castle!

In this guide, you get an overview of the contribution workflow from starting a discussion or opening an issue, to creating, reviewing, and merging a pull request.

For an overview of the project, see README.

Start a discussion

If you have a question or problem, you can search in discussions, if someone has already found a solution to your problem.

Or you can start a new discussion and ask your question.

Create an issue

If you find a problem with Bouncy Castle, search if an issue already exists.

NOTE: If the issue is a potential security problem, please contact us before posting anything public. See Security Policy.

If a related discussion or issue doesn't exist, and the issue is not security related, you can open a new issue. An issue can be converted into a discussion if regarded as one.

Contribute to the code

For substantial, non-trivial contributions, you may be asked to sign a contributor assignment agreement. Optionally, you can also have your name and contact information listed in Contributors.

Please note we are unable to accept contributions which cannot be released under the Bouncy Castle License. Issuing a pull request to make a Contribution on our public github mirror is taken as agreement to issuing under the Bouncy Castle License and to the following conditions:

  • You represent and warrant that: (a) You hold all rights necessary to grant release under the Bouncy Castle License in this in respect of Your Contribution, and Your Contribution, to the best of Your knowledge, will not give rise to any third-party intellectual property infringement claims against the Legion of the Bouncy Castle Inc. or recipients of software distributed by the Legion of the Bouncy Castle Inc.; (b) to the extent any portion of Your Contribution is protected by copyright, You are the author or owner of that portion, or are otherwise duly authorized to grant release under the Bouncy Castle License in respect of it; and (c) where any portion of Your Contribution was generated using generative artificial intelligence tools and is not protected by copyright, You do not represent that portion as owned intellectual property, and You understand that the Legion of the Bouncy Castle Inc. accepts such material on that basis.

  • If any part of Your Contribution was created with the assistance of generative artificial intelligence tools (including large language model-based tools), You represent that: (a) You have disclosed such use to the Legion of the Bouncy Castle Inc. at the time of submission, in accordance with the Legion of the Bouncy Castle Inc.'s contribution guidelines; (b) You have reviewed and understood the AI-generated output incorporated in the Contribution; (c) You have complied with the terms of use of any such tools, including any provisions relating to the ownership of outputs; and (d) to the best of Your knowledge, the Contribution does not reproduce or derive from any third-party material in a manner that would infringe third-party intellectual property rights.

Create a pull request

NOTE: If the issue is a potential security problem, please contact us. See Security Policy.

You are welcome to send patches, under the Bouncy Castle License, as pull requests. For more information, see Creating a pull request. For minor updates, you can instead choose to create an issue with short snippets of code. See above.

  • For contributions touching multiple files try and split up the pull request, smaller changes are easier to review and test, as well as being less likely to run into merge issues.
  • Create a test cases for your change, it may be a simple addition to an existing test. If you do not know how to do this, ask us and we will help you.
  • If you run into any merge issues, check out this git tutorial to help you resolve merge conflicts and other issues.

For more information, refer to the Bouncy Castle documentation on Getting Started with Bouncy Castle.

Self-review

Don't forget to self-review. Please follow these simple guidelines:

  • Keep the patch limited, only change the parts related to your patch.
  • Do not change other lines, such as whitespace, adding line breaks to Java doc, etc. It will make it very hard for us to review the patch.

Your pull request is merged

For acceptance, pull requests need to meet specific quality criteria, including tests for anything substantial. Someone on the Bouncy Castle core team will review the pull request when there is time, and let you know if something is missing or suggest improvements. If it is a useful and generic feature it will be integrated in Bouncy Castle to be available in a later release.