Skip to content

Commit

Permalink
Merge pull request #384 from hmlanigan/schema-issue-template
Browse files Browse the repository at this point in the history
Schema issue template
  • Loading branch information
hmlanigan authored Jan 19, 2024
2 parents 9225b2f + 3c980f7 commit 66018ae
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/FeatureRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ body:
label: "Notes & References"
description: |
Please add relevant notes, links to mattermost chats, other related
issues/PRs, anything to help diagnose understand and develop the
issues/PRs, anything to help diagnose, understand and develop the
feature you want.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/SchemaChanges.yml
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.

0 comments on commit 66018ae

Please sign in to comment.