Skip to content
This repository has been archived by the owner on Sep 26, 2023. It is now read-only.

Commit

Permalink
Add contribute doc page.
Browse files Browse the repository at this point in the history
  • Loading branch information
dmytro committed Sep 19, 2013
1 parent 9f702d4 commit b1bf0b8
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions .yardopts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ docs/API.md
docs/INSTALL.md
docs/CONFIGURATION.md
docs/TROUBLE_SHOOTING.md
docs/CONTRIBUTING.md
docs/nagios_objects.rdoc
LICENSE
History.md
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,7 @@ Dmytro Kovalov, [email protected]
## License

MIT, see {file:LICENSE.rdoc}

## Contributing

If you want to contribute feature, send a bug fix, or simply report a bug or requet a feature see {file:CONTRIBUTING.md}.
26 changes: 26 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# @title How can I help?

## Reporting problems

Please use [Github issue tracker](https://github.com/dmytro/nagira/issues?state=open) if you think you found a bug or problem in Nagira. Also please make sure that such issue was not registered yet, or was not yet fixed in newer versions of Nagira (look at the [closed issues](https://github.com/dmytro/nagira/issues?page=1&state=closed) as well as open ones).

However, if you think issue is related to the security and disclosing the issue can harm current users, please refrain from submitting open bug report, instead please feel free to write private email to me ([email protected]) with the description of the problem (and possible ways to fix it, if you aware of any).

## Contributing

What if you have already fix for the bug, or you have developed new feature, or simply you have great idea how to improve the code?

Before starting development, submitting pull request for the feature or bug-fix please make sure to check issue tracker (above).

Here are steps if you want contribute to the project:

- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request


### That's too difficult ...

Then simply drop me an email at [email protected]

0 comments on commit b1bf0b8

Please sign in to comment.