From e776dc8c6c0af55b07b575adaa9f5506948b690d Mon Sep 17 00:00:00 2001 From: Sean DuBois Date: Thu, 24 Jul 2014 05:09:15 +0000 Subject: [PATCH] Start contributing.md --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..729c49f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +#Running +To quickly run fail2rest just execute `go run *.go` + +#Guidelines + +* Put as much logic as possible into [fail2go](https://github.com/Sean-Der/fail2go) +* Make sure code is properly formated [gofmt](http://blog.golang.org/go-fmt-your-code) +* Make sure you code compiles +* If adding new REST endpoints try to follow the current style + +#REST Style +Currently we have three top level endpoints +* /global (Get/Set information relating to fail2ban) +* /jail/{jail} (Get/Set information relating to a single jail) +* /wwhois/{ip} (Run a WHOIS on the given IP)