diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cc09a0a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +## Issue submission + + * When submitting an issue or bug report, please ensure to provide as much + information as possible, please ensure that you are running on the latest + stable version (tagged), or when using master, provide the specific commit + being used. + * Provide the minimum needed viable source to replicate the problem. + +## Pull Requests + +To review what is currently being worked on, or looked into, feel free to head +over to the [project board](https://github.com/lrstanley/girc/projects/1) or +the [issues list](https://github.com/lrstanley/girc/issues). + +Below are a few guidelines if you would like to contribute. Keep the code +clean, standardized, and much of the quality should match Golang's standard +library and common idioms. + + * Always test using the latest Go version. + * Always use `gofmt` before committing anything. + * Always have proper documentation before committing. + * Keep the same whitespacing, documentation, and newline format as the + rest of the project. + * Only use 3rd party libraries if necessary. If only a small portion of + the library is needed, simply rewrite it within the library to prevent + useless imports. + * Also see [golang/go/wiki/CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments) + +If you would like to assist, and the pull request is quite large and/or it has +the potential of being a breaking change, please open an issue first so it can +be discussed. diff --git a/README.md b/README.md index 147f11e..0d57039 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Coverage Status GoDoc Go Report Card - IRC Chat + IRC Chat

## Status @@ -43,29 +43,19 @@ you're using won't have breaking changes** ## Examples See [the examples](https://godoc.org/github.com/lrstanley/girc#example-package--Bare) -within the documentation for real-world usecases. +within the documentation for real-world usecases. Here are a few real-world +usecases/examples/projects which utilize girc: + +| Project | Description | +| --- | --- | +| [nagios-check-ircd](github.com/lrstanley/nagios-check-ircd) | Nagios script for monitoring the health of an ircd | + +Working on a project and want to add it to the list? Submit a pull request! ## Contributing -To review what is currently being worked on, or looked into, feel free to head -over to the [project board](https://github.com/lrstanley/girc/projects/1) or -the [issues list](https://github.com/lrstanley/girc/issues). - ----- - -Below are a few guidelines if you would like to contribute. Keep the code -clean, standardized, and much of the quality should match Golang's standard -library and common idioms. - - * Always test using the latest Go version. - * Always use `gofmt` before committing anything. - * Always have proper documentation before committing. - * Keep the same whitespacing, documentation, and newline format as the - rest of the project. - * Only use 3rd party libraries if necessary. If only a small portion of - the library is needed, simply rewrite it within the library to prevent - useless imports. - * Also see [golang/go/wiki/CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments) +Please review the [CONTRIBUTING](https://github.com/lrstanley/girc/blob/master/README.md) +doc for submitting issues/a guide on submitting pull requests and helping out. ## License