Contributing to Aquarium
There are several ways in which you can contribute to Aquarium.
Bugs, Enhancement Requests, etc.
Please use the project GitHub issues to submit bug reports and enhancement requests. Discussion of issues on the mailing list is welcome, but the tracker is the best way to capture issues.
It helps greatly if you fork the Aquarium GitHub repository and commit changes (see below).
Bugs
We want to hear about any bugs that you find, but we can’t address them if we can’t reproduce them. If you submit a Bug report, be sure to include:
- The Aquarium version (either a versioned release or Aquarium GitHub repository fork).
- Any other relevant software versions, your OS, etc.
- A failing spec that demonstrates the failure. While code snippets alone are better than nothing, what we really prefer are new specs or modifications to Aquarium’s own specs, committed on a Aquarium GitHub repository fork.
This will make us more likely to look at it quickly.
Feature Requests
Interested in a new feature that you would find useful but don’t wish to develop yourself? Please submit it to the project GitHub issues.
Patches
Interested in a new feature that you’ve already written or want to write? Please submit a patch, but please follow these guidelines.
- Patch using a fork of Aquarium GitHub repository.
- Include updated specs (as appropriate)!
- Include updated docs (as appropriate)!
- Run
rake websiteon your patched source (it runs the specs and generates the docs). - Create a new ticket in the project GitHub issues.
- Mention your GitHub fork.
The Core Team
 |
 |
| Dean Wampler | The Aquarium War Room. |
Acknowledgements
Thanks to Brendan L., Matthew F., Mark V. and others for helpful feedback.
