-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #384 from hmlanigan/schema-issue-template
Schema issue template
- Loading branch information
Showing
2 changed files
with
61 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: Schema Change | ||
description: | | ||
You want to contribute functionality to Terraform Juju Provider, | ||
requiring a schema change? Proceed with this one. | ||
labels: [schema changes] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Contributions are happily accepted. This will help us understand the change | ||
coming and resolve issues before the changes are made. | ||
- type: dropdown | ||
id: Type | ||
attributes: | ||
label: Type of change | ||
description: Are you updating or adding a schema? | ||
options: | ||
- Changing existing schema | ||
- Adding new schema | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: Description | ||
attributes: | ||
label: Description | ||
description: | | ||
Please provide a description of the schema addition or change including why | ||
it is needed. | ||
placeholder: ex. "I plan to implement data source resource X in the provider." | ||
render: terraform | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: Details | ||
attributes: | ||
label: Details | ||
description: | | ||
Details about each schema attribute to be added or modified including | ||
structure contents. Include also why choices were made, especially | ||
about fields being Optional, Computed, etc. | ||
placeholder: | | ||
ex. | ||
"machine_id": schema.StringAttribute{ | ||
Description: "The Juju id of the machine.", | ||
Required: true, | ||
}, | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: Info | ||
attributes: | ||
label: "Notes & References" | ||
description: | | ||
Please add relevant notes, links to matrix chats, other related | ||
issues/PRs, anything to help diagnose understand and develop the | ||
feature you want. |