Add "Contributing" section to README
authorEric Herman <eric@freesa.org>
Sat, 13 Dec 2014 10:21:17 +0000 (11:21 +0100)
committerEric Herman <eric@freesa.org>
Sat, 13 Dec 2014 10:22:59 +0000 (11:22 +0100)
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

README.md

index 095eb79..d1a22f2 100644 (file)
--- 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.