Skip to content

Add CONTRIBUTING.md with development guide #25

@maksimov

Description

@maksimov

Add a CONTRIBUTING.md that covers:

  • How to build and test (go build ./..., go test ./...)
  • Project structure overview (point to README)
  • How to add a new analysis rule (add function in rules.go, add to slice in analyzeInstance, add tests)
  • How to add a new output format
  • How to add a new cloud provider
  • PR conventions (one feature per PR, include tests)

This is the first thing contributors will look for after the README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions