Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 4.19 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 4.19 KB
Raw

Contributing guide

This guide covers contributing to the core functionality of this module. For information on developing a third patry plugin see Developing Plugins

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with contributions:

Getting started

Issues

Create a new issue

If you spot a problem with the modules or sample configs in this repository, search if an issue already exists. If a related issue doesn't exist, you can open a new [issue](!!!ADD REPO LINK HERE!!!).

Solve an issue

Scan through our [existing issues](!!!ADD REPO LINK HERE!!!) to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

  1. Install Git.

  2. If you are an external collaborator, fork the repository.

  3. Install or update to Terraform 1.x.

  4. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:.

pre-commit checklist

  • lint
  • run tests
  • check test coverage
  • add releasenotes
  • update .version-change-type

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link the PR to the appropriate issue:
    • Github issue for external collaborators
  • If you are an external collaborator working from a fork, enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
  • As you commit changes to your branch, you should notice checks running and leaving a green checkmark (checks passed) or a red "x" (checks failed). Make sure all checks have passed.
  • Add details about your changes to RELEASENOTES.md. These are automatically prepended to the CHANGELOG when your PR is merged.
  • Update ./.version-change-type to reflect the type of changes included in your PR. Valid values are major, minor, and patch For a refresher on semver see: https://semver.org/

Your PR is merged!

Congratulations 🎉🎉 The team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible.