Skip to content

Latest commit

 

History

History
127 lines (92 loc) · 4.49 KB

CONTRIBUTING.md

File metadata and controls

127 lines (92 loc) · 4.49 KB
Raw

Contributing

The Flux Terraform provider is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on to make it easier to get your contribution accepted.

We gratefully welcome improvements to issues and documentation as well as to code.

Certificate of Origin

By contributing to the Flux project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution.

We require all commits to be signed. By signing off with your signature, you certify that you wrote the patch or otherwise have the right to contribute the material by the rules of the DCO:

Signed-off-by: Jane Doe <[email protected]>

The signature must contain your real name (sorry, no pseudonyms or anonymous contributions) If your user.name and user.email are configured in your Git config, you can sign your commit automatically with git commit -s.

Communications

For realtime communications we use Slack: To join the conversation, simply join the CNCF Slack workspace and use the #flux-dev channel.

To discuss ideas and specifications we use Github Discussions.

For announcements we use a mailing list as well. Simply subscribe to flux-dev on cncf.io to join the conversation (there you can also add calendar invites to your Google calendar for our Flux meeting).

Developing

Clone the terraform-provider-flux repository.

git clone https://github.com/fluxcd/terraform-provider-flux.git
cd terraform-provider-flux

Run the unit and acceptance tests.

make testacc

Generate the docs if you have made changes to any of the schemas or guides.

make docs

First build the provider, then generate a Terraform CLI config file to use a local build of the provider with Terraform.

make build
make terraformrc
export TF_CLI_CONFIG_FILE="${PWD}/.terraformrc"

Documentation

The documentation is generated from the *.md.tmpl files in templates/ with tfplugindocs.

To generate the documentation, run:

make docs

Documentation is written in Markdown format and supports frontmatter, which should be used to ensure navigation hierarchy. (Markdown) format recommendations should be followed.

New pages can be added by adding a new .md.tmpl file to the templates/ (sub-)directory. Subcategories have an impact on directory structure, other path related assumptions are documented here.

Acceptance policy

These things will make a PR more likely to be accepted:

  • a well-described requirement
  • sign-off all your commits
  • tests for new code
  • tests for old code!
  • new code and tests follow the conventions in old code and tests
  • a good commit message (see below)
  • all code must abide Go Code Review Comments
  • names should abide What's in a name
  • code must build on both Linux and Darwin, via plain go build
  • code should have appropriate test coverage and tests should be written to work with go test

In general, we will merge a PR once one maintainer has endorsed it. For substantial changes, more people may become involved, and you might get asked to resubmit the PR or divide the changes into more than one PR.

Format of the Commit Message

We prefer the following rules for good commit messages:

  • Limit the subject to 50 characters and write as the continuation of the sentence "If applied, this commit will ..."
  • Explain what and why in the body, if more than a trivial change; wrap it at 72 characters.

The following article has some more helpful advice on documenting your work.