Skip to content

Latest commit

 

History

History
31 lines (16 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

31 lines (16 loc) · 1.69 KB
Raw

How to contribute to this Virgil Security SDK

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in a new issue and start writing code.

  • Make sure your new code does not break any tests and include new tests.

  • With good code comes good documentation. Try to copy the existing documentation and adapt it to your needs.

  • Close the issue or mark it as inactive if you decide to discontinue working on the code.

Do you have questions about the source code?

Do you want to contribute to the documentation?

  • Most of our documentation is provided on our Developer Portal, so please let us know if any of your changes to the code will need to be reflected in the documentation.