Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 898 Bytes

CONTRIBUTING.md

File metadata and controls

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.

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