28 lines (21 loc) · 898 Bytes

Contributing to pod-reaper

Issues

Issues are always welcome! You can expect conversation.

Creating a rule

create tests for the rule
implement the rule interface in ./rules/rules.go
add the rule LoadRules method in ./rules/rules.go
ensure your tests pass go test ./rules
format using go fmt ./rules
run the linter golint (https://github.com/golang/lint)

Pull Requests

These rules must be followed for any contributions to be merged into master. A Git installation is required. See here for more information.

Fork this repo
Create a branch
Make an desired changes
Validate you changes meet your desired use case
Ensure documentation has been updated
Format you changes go fmt ./reaper ./rules
Run a go linter with golint (https://github.com/golang/lint)
Open a pull-request: you can expect discussion