|
1 | | -# Contributing to `terraform-provider-archive` |
| 1 | +# Contributing |
2 | 2 |
|
3 | | -**First:** if you're unsure or afraid of _anything_, just ask or submit the issue describing the problem you're aiming to solve. |
| 3 | +Thank you for investing your time and energy by contributing to our project: please ensure you are familiar |
| 4 | +with the [HashiCorp Code of Conduct](https://github.com/hashicorp/.github/blob/master/CODE_OF_CONDUCT.md). |
4 | 5 |
|
5 | | -The `archive` provider is a HashiCorp *standard library* provider, which means we consider it part of the core Terraform experience. Our priority is stability and correctness, and any bug fix or feature has to be considered in the context of this provider's many users and the wider Terraform ecosystem. |
6 | | -This is great as your contribution can have a big positive impact, but we have to assess potential negative impact too. |
| 6 | +This provider is a HashiCorp **utility provider**, which means any bug fix and feature |
| 7 | +has to be considered in the context of the thousands/millions of configurations in which this provider is used. |
| 8 | +This is great as your contribution can have a big positive impact, but we have to assess potential negative impact too |
| 9 | +(e.g. breaking existing configurations). _Stability over features_. |
7 | 10 |
|
8 | | -To provide some safety to the Terraform ecosystem, we strictly follow [semantic versioning](https://semver.org/) and any changes that could be considered as breaking will only be released as part of a major release. |
| 11 | +To provide some safety to the wider provider ecosystem, we strictly follow |
| 12 | +[semantic versioning](https://semver.org/) and HashiCorp's own |
| 13 | +[versioning specification](https://www.terraform.io/plugin/sdkv2/best-practices/versioning#versioning-specification). |
| 14 | +Any changes that could be considered as breaking will only be included as part of a major release. |
| 15 | +In case multiple breaking changes need to happen, we will group them in the next upcoming major release. |
9 | 16 |
|
10 | | -## Table of Contents |
| 17 | +## Asking Questions |
11 | 18 |
|
12 | | - - [I just have a question](#i-just-have-a-question) |
13 | | - - [I want to report a vulnerability](#i-want-to-report-a-vulnerability) |
14 | | - - [New Issue](#new-issue) |
15 | | - - [New Pull Request](#new-pull-request) |
| 19 | +For questions, curiosity, or if still unsure what you are dealing with, |
| 20 | +please see the HashiCorp [Terraform Providers Discuss](https://discuss.hashicorp.com/c/terraform-providers/31) |
| 21 | +forum. |
16 | 22 |
|
17 | | -## I just have a question |
| 23 | +## Reporting Vulnerabilities |
18 | 24 |
|
19 | | -> **Note:** We use GitHub for tracking bugs and feature requests only. |
| 25 | +Please disclose security vulnerabilities responsibly by following the |
| 26 | +[HashiCorp Vulnerability Reporting guidelines](https://www.hashicorp.com/security#vulnerability-reporting). |
20 | 27 |
|
21 | | -For questions, please see relevant channels at https://www.terraform.io/community.html |
| 28 | +## Understanding the design |
22 | 29 |
|
23 | | -## I want to report a vulnerability |
| 30 | +Before proceeding with raising issues or submitting pull requests, it will probably help to familiarise yourself with |
| 31 | +the [design principles](../DESIGN.md) of this provider. This will aid your proposals, and help understand |
| 32 | +why we took certain decisions during development. |
24 | 33 |
|
25 | | -Please disclose security vulnerabilities responsibly by following the procedure |
26 | | -described at https://www.hashicorp.com/security#vulnerability-reporting |
| 34 | +## Raising Issues |
27 | 35 |
|
28 | | -## New Issue |
29 | | - |
30 | | -We welcome issues of all kinds including feature requests, bug reports or documentation suggestions. Below are guidelines for well-formed issues of each type. |
| 36 | +We welcome issues of all kinds including feature requests, bug reports or documentation suggestions. |
| 37 | +Below are guidelines for well-formed issues of each type. |
31 | 38 |
|
32 | 39 | ### Bug Reports |
33 | 40 |
|
34 | | - - **Test against latest release**: Make sure you test against the latest avaiable version of both Terraform and the provider. |
35 | | -It is possible we already fixed the bug you're experiencing. |
36 | | - |
37 | | - - **Search for duplicates**: It's helpful to keep bug reports consolidated to one thread, so do a quick search on existing bug reports to check if anybody else has reported the same thing. You can scope searches by the label `bug` to help narrow things down. |
38 | | - |
39 | | - - **Include steps to reproduce**: Provide steps to reproduce the issue, along with code examples (both HCL and Go, where applicable) and/or real code, so we can try to reproduce it. Without this, it makes it much harder (sometimes impossible) to fix the issue. |
| 41 | +* [ ] **Test against latest release**: Make sure you test against the latest available version of Terraform and the provider. |
| 42 | + It is possible we may have already fixed the bug you're experiencing. |
| 43 | +* [ ] **Search for duplicates**: It's helpful to keep bug reports consolidated to one thread, so do a quick search |
| 44 | + on existing bug reports to check if anybody else has reported the same thing. |
| 45 | + You can scope searches by the label `bug` to help narrow things down. |
| 46 | +* [ ] **Include steps to reproduce**: Provide steps to reproduce the issue, along with code examples and/or real code, |
| 47 | + so we can try to reproduce it. Without this, it makes it much harder (sometimes impossible) to fix the issue. |
40 | 48 |
|
41 | 49 | ### Feature Requests |
42 | 50 |
|
43 | | - - **Search for possible duplicate requests**: It's helpful to keep requests consolidated to one thread, so do a quick search on existing requests to check if anybody else has reported the same thing. You can scope searches by the label `enhancement` to help narrow things down. |
44 | | - |
45 | | - - **Include a use case description**: In addition to describing the behavior of the feature you'd like to see added, it's helpful to also lay out the reason why the feature would be important and how it would benefit the wider Terraform ecosystem. Use case in context of 1 provider is good, wider context of more providers is better. |
| 51 | +* [ ] **Search for possible duplicate requests**: It's helpful to keep requests consolidated to one thread, |
| 52 | + so do a quick search on existing requests to check if anybody else has reported the same thing. |
| 53 | + You can scope searches by the label `enhancement` to help narrow things down. |
| 54 | +* [ ] **Include a use case description**: In addition to describing the behavior of the feature you'd like to see added, |
| 55 | + it's helpful to also make a case for why the feature would be important and how it would benefit |
| 56 | + the provider and, potentially, the wider Terraform ecosystem. |
46 | 57 |
|
47 | 58 | ## New Pull Request |
48 | 59 |
|
49 | 60 | Thank you for contributing! |
50 | 61 |
|
51 | | -We are happy to review pull requests without associated issues, but we highly recommend starting by describing and discussing your problem or feature and attaching use cases to an issue first before raising a pull request. |
| 62 | +We are happy to review pull requests without associated issues, |
| 63 | +but we **highly recommend** starting by describing and discussing |
| 64 | +your problem or feature and attaching use cases to an issue first |
| 65 | +before raising a pull request. |
| 66 | + |
| 67 | +* [ ] **Early validation of idea and implementation plan**: provider development is complicated enough that there |
| 68 | + are often several ways to implement something, each of which has different implications and tradeoffs. |
| 69 | + Working through a plan of attack with the team before you dive into implementation will help ensure that you're |
| 70 | + working in the right direction. |
| 71 | +* [ ] **Tests**: It may go without saying, but every new patch should be covered by tests wherever possible. |
| 72 | + For bug-fixes, tests to prove the fix is valid. For features, tests to exercise the new code paths. |
| 73 | +* [ ] **Go Modules**: We use [Go Modules](https://github.com/golang/go/wiki/Modules) to manage and version our dependencies. |
| 74 | + Please make sure that you reflect dependency changes in your pull requests appropriately |
| 75 | + (e.g. `go get`, `go mod tidy` or other commands). |
| 76 | + Refer to the [dependency updates](#dependency-updates) section for more information about how |
| 77 | + this project maintains existing dependencies. |
| 78 | +* [ ] **Changelog**: Refer to the [changelog](#changelog) section for more information about how to create changelog entries. |
| 79 | + |
| 80 | +### Dependency Updates |
| 81 | + |
| 82 | +Dependency management is performed by [Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates). |
| 83 | +Where possible, dependency updates should occur through that system to ensure all Go module files are appropriately |
| 84 | +updated and to prevent duplicated effort of concurrent update submissions. |
| 85 | +Once available, updates are expected to be verified and merged to prevent latent technical debt. |
| 86 | + |
| 87 | +### Changelog |
| 88 | + |
| 89 | +HashiCorp’s open-source projects have always maintained user-friendly, readable `CHANGELOG`s that allow |
| 90 | +practitioners and developers to tell at a glance whether a release should have any effect on them, |
| 91 | +and to gauge the risk of an upgrade. |
| 92 | + |
| 93 | +We follow Terraform Plugin |
| 94 | +[changelog specifications](https://www.terraform.io/plugin/sdkv2/best-practices/versioning#changelog-specification). |
| 95 | + |
| 96 | +#### Entry format |
| 97 | + |
| 98 | +Entries that are specific to _resources_ or _data sources_, they should look like: |
| 99 | + |
| 100 | +```markdown |
| 101 | +* resource/RESOURCE_NAME: ENTRY DESCRIPTION ([#PR_NUMBER](PR_URL)). |
| 102 | + |
| 103 | +* data-source/DATA-SOURCE_NAME: ENTRY DESCRIPTION ([#PR_NUMBER](PR_URL)). |
| 104 | +``` |
52 | 105 |
|
53 | | -- **Early validation of idea and implementation plan**: Terraform's SDK is complicated enough that there are often several ways to implement something, each of which has different implications and tradeoffs. Working through a plan of attack with the team before you dive into implementation will help ensure that you're working in the right direction. |
| 106 | +#### Which changes should appear in the `CHANGELOG`? |
54 | 107 |
|
55 | | -- **Acceptance Tests**: It may go without saying, but every new patch should be covered by tests wherever possible. |
| 108 | +The `CHANGELOG` is intended to show developer-impacting changes to the codebase for a particular version. |
| 109 | +If every change or commit to the code resulted in an entry, the `CHANGELOG` would become less useful for developers. |
| 110 | +The lists below are general guidelines to decide whether a change should have an entry. |
56 | 111 |
|
57 | | -- **Go Modules**: We use [Go Modules](https://github.com/golang/go/wiki/Modules) to manage and version all our dependencies. Please make sure that you reflect dependency changes in your pull requests appropriately (e.g. `go get`, `go mod tidy` or other commands). Where possible it is better to raise a separate pull request with just dependency changes as it's easier to review such PR(s). |
| 112 | +##### Changes that _should not_ have a `CHANGELOG` entry |
58 | 113 |
|
59 | | -### Cosmetic changes, code formatting, and typos |
| 114 | +* Documentation updates |
| 115 | +* Testing updates |
| 116 | +* Code refactoring |
60 | 117 |
|
61 | | -In general we do not accept PRs containing only the following changes: |
| 118 | +##### Changes that _may_ have a `CHANGELOG` entry |
62 | 119 |
|
63 | | - - Correcting spelling or typos |
64 | | - - Code formatting, including whitespace |
65 | | - - Other cosmetic changes that do not affect functionality |
66 | | - |
67 | | -While we appreciate the effort that goes into preparing PRs, there is always a tradeoff between benefit and cost. The costs involved in accepting such contributions include the time taken for thorough review, the noise created in the git history, and the increased number of GitHub notifications that maintainers must attend to. |
| 120 | +* Dependency updates: If the update contains relevant bug fixes or enhancements that affect developers, |
| 121 | + those should be called out. |
68 | 122 |
|
69 | | -#### Exceptions |
| 123 | +##### Changes that _should_ have a `CHANGELOG` entry |
70 | 124 |
|
71 | | -We belive that one should "leave the campsite cleaner than you found it", so you are welcome to clean up cosmetic issues in the neighbourhood when submitting a patch that makes functional changes or fixes. |
| 125 | +* Major features |
| 126 | +* Bug fixes |
| 127 | +* Enhancements |
| 128 | +* Deprecations |
| 129 | +* Breaking changes and removals |
0 commit comments