|
| 1 | +# Maintainer's Etiquette |
| 2 | + |
| 3 | +Are you a core maintainer of Terraform? Great! Here's a few notes |
| 4 | +to help you get comfortable when working on the project. |
| 5 | + |
| 6 | +This documentation is somewhat outdated since it still includes provider-related |
| 7 | +information even though providers are now developed in their own separate |
| 8 | +codebases, but the general information is still valid. |
| 9 | + |
| 10 | +## Expectations |
| 11 | + |
| 12 | +We value the time you spend on the project and as such your maintainer status |
| 13 | +doesn't imply any obligations to do any specific work. |
| 14 | + |
| 15 | +### Your PRs |
| 16 | + |
| 17 | +These apply to all contributors, but maintainers should lead by examples! :wink: |
| 18 | + |
| 19 | + - for `provider/*` PRs it's useful to attach test results & advise on how to run the relevant tests |
| 20 | + - for `bug` fixes it's useful to attach repro case, ideally in a form of a test |
| 21 | + |
| 22 | +### PRs/issues from others |
| 23 | + |
| 24 | + - you're welcomed to triage (attach labels to) other PRs and issues |
| 25 | + - we generally use 2-label system (= at least 2 labels per issue/PR) where one label is generic and other one API-specific, e.g. `enhancement` & `provider/aws` |
| 26 | + |
| 27 | +## Merging |
| 28 | + |
| 29 | + - you're free to review PRs from the community or other HC employees and give :+1: / :-1: |
| 30 | + - if the PR submitter has push privileges (recognizable via `Collaborator`, `Member` or `Owner` badge) - we expect **the submitter** to merge their own PR after receiving a positive review from either HC employee or another maintainer. _Exceptions apply - see below._ |
| 31 | + - we prefer to use the GitHub's interface or API to do this, just click the green button |
| 32 | + - squash? |
| 33 | + - squash when you think the commit history is irrelevant (will not be helpful for any readers in T+6months) |
| 34 | + - Add the new PR to the **Changelog** if it may affect the user (almost any PR except test changes and docs updates) |
| 35 | + - we prefer to use the GitHub's web interface to modify the Changelog and use `[GH-12345]` to format the PR number. These will be turned into links as part of the release process. Breaking changes should be always documented separately. |
| 36 | + |
| 37 | +## Release process |
| 38 | + |
| 39 | + - HC employees are responsible for cutting new releases |
| 40 | + - The employee cutting the release will always notify all maintainers via Slack channel before & after each release |
| 41 | + so you can avoid merging PRs during the release process. |
| 42 | + |
| 43 | +## Exceptions |
| 44 | + |
| 45 | +Any PR that is significantly changing or even breaking user experience cross-providers should always get at least one :+1: from a HC employee prior to merge. |
| 46 | + |
| 47 | +It is generally advisable to leave PRs labelled as `core` for HC employees to review and merge. |
| 48 | + |
| 49 | +Examples include: |
| 50 | + - adding/changing/removing a CLI (sub)command or a [flag](https://github.com/hashicorp/terraform/pull/12939) |
| 51 | + - introduce a new feature like [Environments](https://github.com/hashicorp/terraform/pull/12182) or [Shadow Graph](https://github.com/hashicorp/terraform/pull/9334) |
| 52 | + - changing config (HCL) like [adding support for lists](https://github.com/hashicorp/terraform/pull/6322) |
| 53 | + - change of the [build process or test environment](https://github.com/hashicorp/terraform/pull/9355) |
| 54 | + |
| 55 | +## Breaking Changes |
| 56 | + |
| 57 | + - we always try to avoid breaking changes where possible and/or defer them to the nearest major release |
| 58 | + - [state migration](https://github.com/hashicorp/terraform/blob/2fe5976aec290f4b53f07534f4cde13f6d877a3f/helper/schema/resource.go#L33-L56) may help you avoid breaking changes, see [example](https://github.com/hashicorp/terraform/blob/351c6bed79abbb40e461d3f7d49fe4cf20bced41/builtin/providers/aws/resource_aws_route53_record_migrate.go) |
| 59 | + - either way BCs should be clearly documented in special section of the Changelog |
| 60 | + - Any BC must always receive at least one :+1: from HC employee prior to merge, two :+1:s are advisable |
| 61 | + |
| 62 | + ### Examples of Breaking Changes |
| 63 | + |
| 64 | + - https://github.com/hashicorp/terraform/pull/12396 |
| 65 | + - https://github.com/hashicorp/terraform/pull/13872 |
| 66 | + - https://github.com/hashicorp/terraform/pull/13752 |
| 67 | + |
| 68 | +## Unsure? |
| 69 | + |
| 70 | +If you're unsure about anything, ask in the committer's Slack channel. |
| 71 | + |
| 72 | +## New Providers |
| 73 | + |
| 74 | +These will require :+1: and some extra effort from HC employee. |
| 75 | + |
| 76 | +We expect all acceptance tests to be as self-sustainable as possible |
| 77 | +to keep the bar for running any acceptance test low for anyone |
| 78 | +outside of HashiCorp or core maintainers team. |
| 79 | + |
| 80 | +We expect any test to run **in parallel** alongside any other test (even the same test). |
| 81 | +To ensure this is possible, we need all tests to avoid sharing namespaces or using static unique names. |
| 82 | +In rare occasions this may require the use of mutexes in the resource code. |
| 83 | + |
| 84 | +### New Remote-API-based provider (e.g. AWS, Google Cloud, PagerDuty, Atlas) |
| 85 | + |
| 86 | +We will need some details about who to contact or where to register for a new account |
| 87 | +and generally we can't merge providers before ensuring we have a way to test them nightly, |
| 88 | +which usually involves setting up a new account and obtaining API credentials. |
| 89 | + |
| 90 | +### Local provider (e.g. MySQL, PostgreSQL, Kubernetes, Vault) |
| 91 | + |
| 92 | +We will need either Terraform configs that will set up the underlying test infrastructure |
| 93 | +(e.g. GKE cluster for Kubernetes) or Dockerfile(s) that will prepare test environment (e.g. MySQL) |
| 94 | +and expose the endpoint for testing. |
| 95 | + |
0 commit comments