Skip to content

Commit e776dc8

Browse files
committed
Start contributing.md
1 parent 8c1a528 commit e776dc8

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#Running
2+
To quickly run fail2rest just execute `go run *.go`
3+
4+
#Guidelines
5+
6+
* Put as much logic as possible into [fail2go](https://github.com/Sean-Der/fail2go)
7+
* Make sure code is properly formated [gofmt](http://blog.golang.org/go-fmt-your-code)
8+
* Make sure you code compiles
9+
* If adding new REST endpoints try to follow the current style
10+
11+
#REST Style
12+
Currently we have three top level endpoints
13+
* /global (Get/Set information relating to fail2ban)
14+
* /jail/{jail} (Get/Set information relating to a single jail)
15+
* /wwhois/{ip} (Run a WHOIS on the given IP)

0 commit comments

Comments
 (0)