diff --git a/.github/ISSUE_TEMPLATE/internal-epic.yml b/.github/ISSUE_TEMPLATE/internal-epic.yml index 504514a3..2f3bfaa7 100644 --- a/.github/ISSUE_TEMPLATE/internal-epic.yml +++ b/.github/ISSUE_TEMPLATE/internal-epic.yml @@ -59,6 +59,24 @@ body: validations: required: false + - type: textarea + attributes: + label: Documentation + description: | + Provide a list of relevant documentation. Is there a proof of concept? + Does this require and RFCs, ADRs, etc.? + If the documentation exists, link it; if it does not exist yet, reference it descriptively. + + Example: + - [ ] RFC for updating connection interface to accept new parameters + - [ ] POC: https://github.com/dbt-labs/dbt-adapters/pull/42 + value: | + ```[tasklist] + - [ ] Task + ``` + validations: + required: false + - type: textarea attributes: label: Consequences diff --git a/.github/ISSUE_TEMPLATE/internal-feature-implementation.yml b/.github/ISSUE_TEMPLATE/internal-feature-implementation.yml index 217e847b..ab3c4ffc 100644 --- a/.github/ISSUE_TEMPLATE/internal-feature-implementation.yml +++ b/.github/ISSUE_TEMPLATE/internal-feature-implementation.yml @@ -54,7 +54,7 @@ body: - type: textarea attributes: - label: Suggested tests + label: Testing description: | Provide scenarios to test. Include both positive and negative tests if possible. Link to existing similar tests if appropriate. @@ -71,13 +71,24 @@ body: - type: textarea attributes: - label: Are there any security concerns with these changes? + label: Security description: | + Are there any security concerns with these changes? When in doubt, run it by the security team. placeholder: | Example: Logging sensitive data validations: - required: true + required: true + + - type: textarea + attributes: + label: Docs + description: | + Are there any docs the will need to be added or updated? + placeholder: | + Example: We need to document how to configure this new authentication method. + validations: + required: true - type: textarea attributes: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 747dbc2d..4fc2fcf8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -30,6 +30,6 @@ resolves # ### Checklist - [ ] I have read [the contributing guide](https://github.com/dbt-labs/dbt-adapter/blob/main/CONTRIBUTING.md) and understand what's expected of me -- [ ] I have run this code in development and it appears to resolve the stated issue +- [ ] I have run this code in development, and it appears to resolve the stated issue - [ ] This PR includes tests, or tests are not required/relevant for this PR -- [ ] This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc) or this PR has already received feedback and approval from Product or DX +- [ ] This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX