Skip to content

Commit eb676a9

Browse files
Merge pull request #15 from fivetran/MagicBot/documentation-updates
Documentation Standard Updates
2 parents fce24ad + f34d4d6 commit eb676a9

File tree

6 files changed

+73
-67
lines changed

6 files changed

+73
-67
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+21-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: 🐞 Bug
22
description: Report a bug or an issue you've found within the dbt package
33
title: "[Bug] <title>"
4-
labels: ["bug", "triage"]
4+
labels: ["type:bug"]
55
body:
66
- type: markdown
77
attributes:
@@ -35,6 +35,12 @@ body:
3535
description: A concise description of what you expected to happen.
3636
validations:
3737
required: true
38+
- type: textarea
39+
attributes:
40+
label: Possible solution
41+
description: Were you able to investigate and/or discover a potential fix to this bug in your investigation? If so, it would be much appreciated if you could submit code samples to show us how your fix resolved this issue.
42+
validations:
43+
required: false
3844
- type: textarea
3945
attributes:
4046
label: dbt Project configurations
@@ -61,6 +67,19 @@ body:
6167
- other (mention it in "Additional Context")
6268
validations:
6369
required: true
70+
- type: dropdown
71+
id: orchestration_type
72+
attributes:
73+
label: How are you running this dbt package?
74+
multiple: true
75+
options:
76+
- Fivetran Quickstart Data Model
77+
- Fivetran Transformations
78+
- dbt Core™
79+
- dbt Cloud™
80+
- other (mention it in "Additional Context")
81+
validations:
82+
required: true
6483
- type: textarea
6584
attributes:
6685
label: dbt Version
@@ -83,6 +102,6 @@ body:
83102
description: Our team will assess this issue and let you know if we will add it to a future sprint. However, if you would like to expedite the solution, we encourage you to contribute to the package via a PR. Our team will then work with you to approve and merge your contributions as soon as possible.
84103
options:
85104
- label: Yes.
86-
- label: Yes, but I will need assistance and will schedule time during our [office hours](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) for guidance
105+
- label: Yes, but I will need assistance.
87106
- label: No.
88107
required: false

.github/ISSUE_TEMPLATE/config.yml

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ contact_links:
22
- name: Provide feedback to our dbt package team
33
url: https://www.surveymonkey.com/r/DQ7K7WW
44
about: Fill out our survey form to provide valuable feedback to the Fivetran team developing and maintaining the dbt packages.
5-
- name: Ask a question during our office hours
6-
url: https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours
7-
about: Schedule time during the external office hours block with the Fivetran Analytics Engineering team for support
85
- name: Fivetran connector question
96
url: https://support.fivetran.com/hc
107
about: Have a question about your connector? Check out the Fivetran support portal for more details.
@@ -13,4 +10,4 @@ contact_links:
1310
about: Check out the dbt docs for all dbt related information
1411
- name: Hang out in dbt Slack
1512
url: https://www.getdbt.com/community/
16-
about: Have a question or just want to chat with fellow data friends, join dbt Slack and hangout in the tools-fivetran channel with us!
13+
about: Have a question or just want to chat with fellow data friends, join dbt Slack and hangout in the tools-fivetran channel with us!

.github/ISSUE_TEMPLATE/feature-request.yml

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: 🎉 Feature
22
description: Suggest a new feature for the Fivetran dbt package
33
title: "[Feature] <title>"
4-
labels: ["enhancement"]
4+
labels: ["type:enhancement"]
55
body:
66
- type: markdown
77
attributes:
@@ -20,6 +20,13 @@ body:
2020
description: A clear and concise description of what you want to happen and why you want the new feature.
2121
validations:
2222
required: true
23+
- type: textarea
24+
attributes:
25+
label: How would you implement this feature?
26+
description: |
27+
How would you build out this feature with your existing data? Any code examples you can provide to help accelerate development on this issue?
28+
validations:
29+
required: true
2330
- type: textarea
2431
attributes:
2532
label: Describe alternatives you've considered
@@ -34,7 +41,7 @@ body:
3441
description: Our team will assess this feature and let you know if we will add it to a future sprint. However, if you would like to expedite the feature, we encourage you to contribute to the package via a PR. Our team will then work with you to approve and merge your contributions as soon as possible.
3542
options:
3643
- label: Yes.
37-
- label: Yes, but I will need assistance and will schedule time during your [office hours](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) for guidance.
44+
- label: Yes, but I will need assistance.
3845
- label: No.
3946
required: false
4047
- type: textarea

.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md

+10-32
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,26 @@
44
**This PR will result in the following new package version:**
55
<!--- Please add details around your decision for breaking vs non-breaking version upgrade. If this is a breaking change, were backwards-compatible options explored? -->
66

7-
**Please detail what change(s) this PR introduces and any additional information that should be known during the review of this PR:**
7+
**Please provide the finalized CHANGELOG entry which details the relevant changes included in this PR:**
8+
<!--- Copy/paste the CHANGELOG for this version below. -->
89

910
## PR Checklist
1011
### Basic Validation
1112
Please acknowledge that you have successfully performed the following commands locally:
12-
- [ ] dbt compile
13-
- [ ] dbt run –full-refresh
14-
- [ ] dbt run
15-
- [ ] dbt test
16-
- [ ] dbt run –vars (if applicable)
13+
- [ ] dbt run –full-refresh && dbt test
14+
- [ ] dbt run (if incremental models are present) && dbt test
1715

1816
Before marking this PR as "ready for review" the following have been applied:
19-
- [ ] The appropriate issue has been linked and tagged
20-
- [ ] You are assigned to the corresponding issue and this PR
17+
- [ ] The appropriate issue has been linked, tagged, and properly assigned
18+
- [ ] All necessary documentation and version upgrades have been applied
19+
- [ ] docs were regenerated (unless this PR does not include any code or yml updates)
2120
- [ ] BuildKite integration tests are passing
21+
- [ ] Detailed validation steps have been provided below
2222

2323
### Detailed Validation
24-
Please acknowledge that the following validation checks have been performed prior to marking this PR as "ready for review":
25-
- [ ] You have validated these changes and assure this PR will address the respective Issue/Feature.
26-
- [ ] You are reasonably confident these changes will not impact any other components of this package or any dependent packages.
27-
- [ ] You have provided details below around the validation steps performed to gain confidence in these changes.
24+
Please share any and all of your validation steps:
2825
<!--- Provide the steps you took to validate your changes below. -->
2926

30-
### Standard Updates
31-
Please acknowledge that your PR contains the following standard updates:
32-
- Package versioning has been appropriately indexed in the following locations:
33-
- [ ] indexed within dbt_project.yml
34-
- [ ] indexed within integration_tests/dbt_project.yml
35-
- [ ] CHANGELOG has individual entries for each respective change in this PR
36-
<!--- If there is a parallel upstream change, remember to reference the corresponding CHANGELOG as an individual entry. -->
37-
- [ ] README updates have been applied (if applicable)
38-
<!--- Remember to check the following README locations for common updates. →
39-
<!--- Suggested install range (needed for breaking changes) →
40-
<!--- Dependency matrix is appropriately updated (if applicable) →
41-
<!--- New variable documentation (if applicable) -->
42-
- [ ] DECISIONLOG updates have been updated (if applicable)
43-
- [ ] Appropriate yml documentation has been added (if applicable)
44-
45-
### dbt Docs
46-
Please acknowledge that after the above were all completed the below were applied to your branch:
47-
- [ ] docs were regenerated (unless this PR does not include any code or yml updates)
48-
4927
### If you had to summarize this PR in an emoji, which would it be?
5028
<!--- For a complete list of markdown compatible emojis check our this git repo (https://gist.github.com/rxaviers/7360908) -->
51-
:dancer:
29+
:dancer:

.github/pull_request_template.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,13 @@
1919
<!--- To select a checkbox you simply need to add an "x" with no spaces between the brackets (eg. [x] Yes). -->
2020
- [ ] Yes
2121

22-
**Provide an emoji that best describes your current mood**
22+
**Typically there are additional maintenance changes required before this will be ready for an upcoming release. Are you comfortable with the Fivetran team making a few commits directly to your branch?**
23+
<!--- If you select Yes this will help expedite your PR in case there are small changes required before approval. We encourage you not to use this branch in a production environment as we may make additional updates. -->
24+
<!--- If you select No, we will not make any changes directly to your branch and will either communicate any planned changes via the PR thread or will merge your PR into a separate branch so we may make changes without modifying your branch.. -->
25+
- [ ] Yes
26+
- [ ] No
27+
28+
**If you had to summarize this PR in an emoji, which would it be?**
2329
<!--- For a complete list of markdown compatible emojis check our this git repo (https://gist.github.com/rxaviers/7360908) -->
2430
:dancer:
2531

0 commit comments

Comments
 (0)