Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 1015 Bytes

contributing.md

File metadata and controls

25 lines (15 loc) · 1015 Bytes

How to contribute to Aquarium

If you found a bug in a protocol

Unless you can determine that the protocol bug is due to a bug in Aquarium, don't report it here.

If you found an issue in the documentation

Aquarium documentation lives in the Aquaverse project and not here.

If you found a bug in Aquarium

  • Do not open a GitHub issue if the bug is a security vulnerability.
  • Make sure the bug is not already reported by searching the issues.
  • If you do not find the bug in the current issues, open a new issue

If you fix a bug in Aquarium

  • Include a test that demonstrates the bug and that it is resolved by the fix.
  • Open a new GitHub pull request with the code for the fix.
  • Ensure the PR description describes the problem and solution. Reference the issue number if one exists.

If you want to add a feature to Aquarium

  • Check in first.