Skip to content

Commit

Permalink
Start contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean-Der committed Jul 24, 2014
1 parent 8c1a528 commit e776dc8
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit e776dc8

Please sign in to comment.