Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 939 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 939 Bytes

Thanks for wanting to contribute to this project ❤️.

This project accepts contributions. In order to contribute, you should pay attention to a few things:

  1. Your code must follow the coding style rules
  2. Your code must be fully documented
  3. Your code must have acceptance test
  4. Your new resource needs to be imported by the user
  5. Please test your new resources, datasources and acceptance tests
  6. GitHub Pull Requests

Coding and documentation Style:

  • Code must be formatted with make fmt command
  • Documentation must be created with make doc command

Acceptance tests:

  • Each resource and/or datasource need to have an acceptance test
  • Acceptance tests must be run and must pass
  • Don't forget to add or modify existing sweeper method if you think the acceptance tests may leave orphan resources on failure

Submitting Modifications:

The contributions should be submitted through new GitHub Pull Requests.