Skip to content

Commit 4bbbce3

Browse files
authored
Merge pull request #1525 from json-schema-org/gregsdennis/github-templates
update issue and pr templates
2 parents 53ad7d6 + 7420783 commit 4bbbce3

File tree

4 files changed

+89
-3
lines changed

4 files changed

+89
-3
lines changed

.github/ISSUE_TEMPLATE.md

-2
This file was deleted.
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 🧹 Clarification Needed
2+
description: Something in the specification is unclear
3+
title: "🧹 Clarification: "
4+
labels: ["🧹 Clarification", "Status: Triage"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Specification section
9+
description: Which specification document needs clarification? Which section?
10+
placeholder: |
11+
[Core | Validation], Section: ?
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: What is unclear?
17+
description: Please quote the current text and explain why it's unclear.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Proposal
23+
description: Do you have an idea to make the text more clear?
24+
validations:
25+
required: true
26+
- type: dropdown
27+
attributes:
28+
label: Do you think this work might require an [Architectural Decision Record (ADR)]? (significant or noteworthy)
29+
options:
30+
- 'Yes'
31+
- 'No'
32+
validations:
33+
required: true

.github/ISSUE_TEMPLATE/proposal.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: ⭐️ Proposal
2+
description: Suggest an idea for a new feature
3+
title: "✨ Proposal: "
4+
labels: ["proposal", "Status: Triage"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe the inspiration for your proposal
9+
description: Does the proposal address a problem you're facing?
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Describe the proposal
15+
description: Please be as clear as possible and use examples.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Describe alternatives you've considered
21+
description: Can the functionality you're proposal be achieved with the features available today?
22+
validations:
23+
required: false
24+
- type: textarea
25+
attributes:
26+
label: Additional context
27+
description: Is there anything else related to your proposal that you'd like to cover?
28+
validations:
29+
required: false

.github/PULL_REQUEST_TEMPLATE.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
11
<!-- Love json-schema? Please consider supporting our collective:
2-
👉 https://opencollective.com/json-schema/donate -->
2+
👉 https://opencollective.com/json-schema/donate -->
3+
4+
<!-- In order to keep off topic discussion to a minimum, it helps if the "work to be done" is already agreed on. -->
5+
<!-- Ideally, a GitHub Issue with the label `Status: Consensus` will have been concluded, and linked to in this PR. -->
6+
7+
<!--
8+
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request.
9+
-->
10+
11+
### What kind of change does this PR introduce?
12+
13+
<!-- E.g. a bugfix, feature, refactoring, etc… -->
14+
15+
### Issue & Discussion References
16+
17+
<!-- Pick at least one of the below options, and remove those which don't apply. -->
18+
- Closes #___ <!-- Replace ___ with the issue number this PR resolves -->
19+
- Related to #___ <!-- Use when the PR doesn't completely resolve an issue -->
20+
- Others? <!-- Add any additional notes or references here -->
21+
22+
### Summary
23+
24+
<!-- Explain the motivation for making this change. What existing problem does the pull request solve? -->
25+
26+
### Does this PR introduce a breaking change?
27+
28+
<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->

0 commit comments

Comments
 (0)