Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (14 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

23 lines (14 loc) · 1.12 KB

Contributing

Updating Provider Documentation

The documentation is generated using tfplugindocs.

docs/ should never be edited by hand. Instead, update the documentation via updating Description fields within the schema blocks of the provider's resources and data sources. And if needed, update the templates in templates/.

You can always run the following command locally to re-generate the documentation:

make docs

Submitting a PR

  1. Fork the repo
  2. Create a PR from your fork against the master branch

PR Requirements

  1. Ensure that all tests pass (via commenting /test if you are an admin or a contributor with write access on this repo, otherwise wait for a maintainer to submit the comment. The comment will be ignored if you are not an admin or a contributor with write access on this repo. See: https://codefresh.io/docs/docs/pipelines/triggers/git-triggers/#support-for-building-pull-requests-from-forks)
  2. Ensure make docs and make fmt have been run and the changes have been committed. Otherwise, you will have failing status checks.