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.

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

update issue and pr templates #1525

Merged
merged 1 commit into from
Jul 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/clarification.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: 🧹 Clarification Needed
description: Something in the specification is unclear
title: "🧹 Clarification: "
labels: ["🧹 Clarification", "Status: Triage"]
body:
- type: textarea
attributes:
label: Specification section
description: Which specification document needs clarification? Which section?
placeholder: |
[Core | Validation], Section: ?
validations:
required: true
- type: textarea
attributes:
label: What is unclear?
description: Please quote the current text and explain why it's unclear.
validations:
required: true
- type: textarea
attributes:
label: Proposal
description: Do you have an idea to make the text more clear?
validations:
required: true
- type: dropdown
attributes:
label: Do you think this work might require an [Architectural Decision Record (ADR)]? (significant or noteworthy)
options:
- 'Yes'
- 'No'
validations:
required: true
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: ⭐️ Proposal
description: Suggest an idea for a new feature
title: "✨ Proposal: "
labels: ["proposal", "Status: Triage"]
body:
- type: textarea
attributes:
label: Describe the inspiration for your proposal
description: Does the proposal address a problem you're facing?
validations:
required: true
- type: textarea
attributes:
label: Describe the proposal
description: Please be as clear as possible and use examples.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: Can the functionality you're proposal be achieved with the features available today?
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: Is there anything else related to your proposal that you'd like to cover?
validations:
required: false
28 changes: 27 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
<!-- Love json-schema? Please consider supporting our collective:
👉 https://opencollective.com/json-schema/donate -->
👉 https://opencollective.com/json-schema/donate -->

<!-- In order to keep off topic discussion to a minimum, it helps if the "work to be done" is already agreed on. -->
<!-- Ideally, a GitHub Issue with the label `Status: Consensus` will have been concluded, and linked to in this PR. -->

<!--
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request.
-->

### What kind of change does this PR introduce?

<!-- E.g. a bugfix, feature, refactoring, etc… -->

### Issue & Discussion References

<!-- Pick at least one of the below options, and remove those which don't apply. -->
- Closes #___ <!-- Replace ___ with the issue number this PR resolves -->
- Related to #___ <!-- Use when the PR doesn't completely resolve an issue -->
- Others? <!-- Add any additional notes or references here -->

### Summary

<!-- Explain the motivation for making this change. What existing problem does the pull request solve? -->

### Does this PR introduce a breaking change?

<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->
Loading