Skip to content

Commit 7d4705c

Browse files
authored
chore: Adding issue and PR templates (#3135)
* chore: Adding issue and PR templates * Temporarily removing CODEOWNERs checkbox as the file doesn't exist yet. * Adding link to style guide per suggestion
1 parent fe0d450 commit 7d4705c

File tree

3 files changed

+76
-0
lines changed

3 files changed

+76
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Please let us know which issues you are having.
4+
title: ''
5+
labels: 'priority: p2, triage me, type: bug'
6+
assignees: ''
7+
8+
---
9+
10+
Thanks for stopping by to let us know something could be better!
11+
12+
**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.
13+
14+
**The issue you're having must be related to a file in this repository.** We are unable to provide assistance for issues unrelated to samples in this repository.
15+
16+
Please include as much information as possible:
17+
18+
## In which file did you encounter the issue?
19+
<!-- Please provide the full path to the file, to avoid ambiguity -->
20+
21+
## Did you change the file? If so, how?
22+
<!-- A diff would be helpful; otherwise, a description -->
23+
24+
## Describe the issue
25+
<!-- Please be specific. Copying and pasting your invocation and the entire
26+
output is often helpful. -->
27+
28+
Making sure to follow these steps will guarantee the quickest resolution possible.
29+
30+
Thanks!
+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature request
3+
about: Let us know how we can make things better.
4+
title: ''
5+
labels: 'priority: p3, triage me, type: feature request'
6+
assignees: ''
7+
8+
---
9+
10+
Thanks for stopping by to let us know something could be better!
11+
12+
**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.
13+
14+
**The issue you're having must be related to a file in this repository.** We are unable to provide assistance for issues unrelated to samples in this repository.
15+
16+
Please include as much information as possible:
17+
18+
## Is your feature request related to a problem? Please describe.
19+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
20+
21+
## Describe the solution you'd like.
22+
<!-- A clear and concise description of what you want to happen. -->
23+
24+
## Describe alternatives you've considered.
25+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
26+
27+
## Additional context.
28+
<!-- Add any other context or screenshots about the feature request here. -->
29+
30+
Making sure to follow these steps will guarantee the quickest resolution possible.
31+
32+
Thanks!

.github/PULL_REQUEST_TEMPLATE.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Description
2+
3+
Fixes #<ISSUE-NUMBER>
4+
5+
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
6+
7+
## Checklist
8+
- [ ] I have followed guidelines from [CONTRIBUTING.MD](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/CONTRIBUTING.md) and [Samples Style Guide](https://googlecloudplatform.github.io/samples-style-guide/)
9+
- [ ] **Tests** pass: `npm test` (see [Testing](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/CONTRIBUTING.md#run-the-tests-for-a-single-sample))
10+
- [ ] **Lint** pass: `npm run lint` (see [Style](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/CONTRIBUTING.md#style))
11+
- [ ] These samples need a new **API enabled** in testing projects to pass (let us know which ones)
12+
- [ ] These samples need a new/updated **env vars** in testing projects set to pass (let us know which ones)
13+
- [ ] This sample adds a new **Product API**, and I updated the [Blunderbuss issue/PR auto-assigner](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/.github/blunderbuss.yml) with the codeowners for this sample
14+
- [ ] Please **merge** this PR for me once it is approved

0 commit comments

Comments
 (0)