Skip to content
This repository has been archived by the owner on Jun 13, 2020. It is now read-only.

Commit

Permalink
Tell folks how they can contribute to the project.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Frantz committed Jun 27, 2014
1 parent 8bb08cf commit 2ed297a
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contribute

To contribute to ``nagios-herald``, you need to follow a few easy steps:

1. Fork the repo.
2. Clone your fork.
3. Hack on your favorite bits like the formatters, helpers, etc.
4. If you are adding new functionality, document it in its own file under ``docs/``.
5. If necessary, rebase your commits into logical chunks, without errors.
6. Verify your code by running the test suite, and adding additional tests if you can.
7. Push the branch up to GitHub.
8. Send a pull request.

We'll do our best to get your changes in!

## How to Run Tests

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
```

0 comments on commit 2ed297a

Please sign in to comment.