Skip to content

Commit

Permalink
Add docs section to epic and feature templates (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikealfare authored Feb 28, 2024
1 parent fc2e76b commit 5bc38c3
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 5 deletions.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/internal-epic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 14 additions & 3 deletions .github/ISSUE_TEMPLATE/internal-feature-implementation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 5bc38c3

Please sign in to comment.