Contributing¶
All contributions, both code and documentation, are welcome!
Source¶
The source code is located at https://github.com/juju/charm-helpers. To submit contributions you’ll need to create a GitHub account if you do not already have one.
To get the code:
$ git clone https://github.com/juju/charm-helpers
To build and run tests:
$ cd charm-helpers
$ make
Submitting a Merge Proposal¶
Run make test
and ensure all tests pass. Then commit your changes to a
fork and create a
pull request.
Open Bugs¶
If you’re looking for something to work on, the open bug/feature list can be found at https://bugs.launchpad.net/charm-helpers.
Documentation¶
If you’d like to contribute to the documentation, please refer to the HACKING.md
document in the root of the source tree for instructions on building the documentation.
Contributions to the Examples section of the documentation are
especially welcome, and are easy to add. Simply add a new .rst
file under
charmhelpers/docs/examples
.
Getting Help¶
If you need help you can find it in #juju
on the Freenode IRC network. Come
talk to us - we’re a friendly bunch!