Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1004 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1004 Bytes

Contributing

Scopes

When you need to use a scope in a commit message, use the directories under pkg as a reference to specify the scope. Some suggestions:

  • aws
  • gcp
  • azure
  • ...

When opening a new PR

  • The following requirements are checked in a PR:
    • make build
    • make test-unit
    • make test-integration # These requires a real environment (draios-demo) and are slower than the others.
    • make test-e2e
    • make test-rules
    • make lint

Testing

It's recommended to use an .envrc file to keep environment variables under control. Check .envrc.template for a reference.

Release

  • push a new tag and the Github Action will draft a release (with notes)