From: Eric Herman Date: Sat, 13 Dec 2014 10:21:17 +0000 (+0100) Subject: Add "Contributing" section to README X-Git-Url: http://git.iain.cx/?p=pstop.git;a=commitdiff_plain;h=724089cf7925d3e7f54f4b9cf7be341d6fdbe8bf Add "Contributing" section to README Mostly this is to point novice contributors to a standard go-way of contributing. Which while not perfect, is probably much better than chaning the paths in the sources all the time. (Which is of course doable: https://github.com/ericherman/code-snips/blob/master/shell/set_repo but probably not a good idea.) Also added a LICENSING section --- diff --git a/README.md b/README.md index 095eb79..d1a22f2 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,6 @@ update or delete activity. User activity is now shown showing the number of different hosts that connect with the same username and the actiity of those users. -This program was started as a simple project to allow me to learn -go, which I'd been following for a while, but hadn't used in earnest. -This probably shows in the code so suggestions on improvement are -most welcome. - ### Installation Install and update this go package with `go get -u github.com/sjmudd/pstop` @@ -62,6 +57,21 @@ See also: * [NEW_FEATURES](https://github.com/sjmudd/pstop/blob/master/NEW_FEATURES) which describe things that probably need looking at * [screen_samples.txt](https://github.com/sjmudd/pstop/blob/master/screen_samples.txt) provides some sample output from my own system. +### Contributing + +This program was started as a simple project to allow me (Simon) to learn +go, which I'd been following for a while, but hadn't used in earnest. +This probably shows in the code so suggestions on improvement are +most welcome. + +You may find "Contributing to Open Source Git Repositories in Go" +by Katrina Owen to be useful: +https://blog.splice.com/contributing-open-source-git-repositories-go/ + +### Licensing + +BSD 2-Clause License + ### Feedback Feedback and patches welcome.