To contribute to nagios-herald, you need to follow a few easy steps:
- Fork the repo.
- Clone your fork.
- Hack on your favorite bits like the formatters, helpers, etc.
- If you are adding new functionality, document it in its own file under
docs/. - If necessary, rebase your commits into logical chunks, without errors.
- Verify your code by running the test suite, and adding additional tests if you can.
- Push the branch up to GitHub.
- Send a pull request.
We'll do our best to get your changes in!
The tests are written using Ruby's minitest.
Name your tests with the test_ prefix and place them in the test/unit/
directory.
When you're ready to run your tests, simply run rake:
% rake test