Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refine PR and Issue templates #1024

Merged
merged 6 commits into from
Sep 1, 2023
Merged

Refine PR and Issue templates #1024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fd76462
Add migration guide link to issue tmpl
inancgumus Sep 1, 2023
f701141
Update community forum link
inancgumus Sep 1, 2023
0562364
Keep issue tmpl headings concise
inancgumus Sep 1, 2023
4ce6018
Add team issue template
inancgumus Sep 1, 2023
d0afa99
Update PR template
inancgumus Sep 1, 2023
bca88d4
Improve issue template suggestion wording
inancgumus Sep 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: xk6-browser Community Forum
url: https://community.k6.io/c/xk6-browser/14
- name: Community Forum
inancgumus marked this conversation as resolved.
Show resolved Hide resolved
url: https://community.grafana.com/c/grafana-k6/k6-browser/79
ka3de marked this conversation as resolved.
Show resolved Hide resolved
about: Please ask and answer questions here.
- name: xk6-browser Documentation
- name: Documentation
url: https://github.com/grafana/k6-docs
about: Please add any documentation related issues here.
- name: Migration Guide
url: https://k6.io/docs/using-k6-browser/migrating-to-k6-v0-46/
about: Please review the guide if you're migrating to k6 v0.46+ from an older version of xk6-browser.
inancgumus marked this conversation as resolved.
Show resolved Hide resolved
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/team_issues.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Team issue template
description: This template is reserved for team members.
inancgumus marked this conversation as resolved.
Show resolved Hide resolved
title: "Keep the title concise. Use the common language we can use to identify the issue."
body:
- type: textarea
attributes:
label: What?
description: A concise (or detailed) description of this issue's goal.
validations:
required: true
- type: textarea
attributes:
label: Why?
description: A concise (or detailed) explanation of why we need this issue.
validations:
required: true
- type: textarea
attributes:
label: How?
description: Do you have any suggestions/solutions on how to solve the issue?
validations:
required: false
- type: textarea
attributes:
label: Tasks
description: Feel free to remove the tasklist items that are not relevant for this issue.
value: |
```[tasklist]
### Tasks
- [ ] Subissue
ka3de marked this conversation as resolved.
Show resolved Hide resolved
- [ ] PR
- [ ] Docs PR
- [ ] TypeScript Definitions PR
- [ ] Update the k6 release notes
```
validations:
required: false
- type: textarea
attributes:
label: Related PR(s)/Issue(s)
description: Related issues, PRs, external reference links, etc.
validations:
required: false
8 changes: 0 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,6 @@ and code of conduct https://github.com/grafana/k6/blob/master/CODE_OF_CONDUCT.md
- [ ] I have added tests for my changes
- [ ] I have commented on my code, particularly in hard-to-understand areas

<!--
If relevant:
- [ ] I have updated the k6 release notes: PR link
- [ ] I have updated the k6 documentation: PR link
- [ ] I have updated [k6 browser get started](https://k6.io/blog/get-started-with-k6-browser/) blog: PR link
- [ ] Generated and updated the [TypeScript definitions](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6/experimental/browser)
-->

## Related PR(s)/Issue(s)

<!-- Does it close an issue? -->
Expand Down
Loading