Our documentation for how to contribute was in quite a state of disrepair,
with some documents still describing things as they were before moving
providers into separate repositories, others making assumptions about
Go development that are no longer true in modules mode, and so forth.
This is an attempt at a reset to a good state that should work with the
codebase as it currently stands, and should hopefully serve as a basis
for iterative improvement from here.
These new instructions lean primarily on standard Go toolchain usage and
instruct using the Makefile only for some Terraform-specific situations
that the Go toolchain does not automatically handle. The idea here is that
this direct usage of primary commands in the Go toolchain is less likely
to be broken by changes in future Go releases, and should be immediately
familiar to anyone who has experience with Go development.
* website/contributing: update contribution documentation
This PR seeks to remove outdated and incorrect information. There is
still work to be done updating the information that's left; this is
merely the first step.
Here our prior existing single template becomes the "Bug report" template,
and we introduce a second "Feature request" template that is more
appropriate for gathering context about a feature request.
As pointed out in #16987, "factoids" are not really what we're looking for here. The goal of this section is to capture additional context that isn't represented by any of our other section headings, so we'll change this to "Additional Context" to be clearer about what we want here and to avoid a confusing misuse of a quirky English word that not all readers will be familiar with.
By wrapping the instruction portions in comments we can get a cleaner rendering of the issue if a user posts it without removing the instructions first.
The content is otherwise the same as before.
This is just a few editorial tweaks to the issue template.
The primary motivation here was to shorten the section about provider issues now that we're no longer in the transitional state; I suspect that this scary wall of text is dissuading people from actually reading and following the template.
Otherwise, this is just some tweaks to the wording and some adjustments for the fact that we're now not expecting provider issues here.
* Update ISSUE_TEMPLATE
Update ISSUE_TEMPLATE to direct people to new split providers
* Create ISSUE_TEMPLATE.md
More loud
* Update ISSUE_TEMPLATE.md
* Create ISSUE_TEMPLATE.md
* Create ISSUE_TEMPLATE.md
moved to the top
Alisdair McDiarmid