Mirror/fail2rest
1
0
Fork 0
mirror of https://github.com/Sean-Der/fail2rest.git synced 2024-12-22 05:32:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

Start contributing.md

Browse source
This commit is contained in:
Sean DuBois 2014-07-24 05:09:15 +00:00
parent 8c1a528ccb
commit e776dc8c6c
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md Normal file
View file

@ -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)