Skip to content

Commit da29cd7

Browse files
authored
Merge pull request #36 from Relequestual/feature/adr-templates
Add Issue and Pull Request templates, mainly for ADRs
2 parents 8df1c76 + ec81d3e commit da29cd7

File tree

4 files changed

+74
-0
lines changed

4 files changed

+74
-0
lines changed

.github/ISSUE_TEMPLATE/action_item.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Action Item
3+
about: Use this template for creating work to be done, usually in relation to a GitHub Discussion
4+
---
5+
6+
**GitHub Discussion:** # / NA
7+
8+
**Work Summary**:
9+
<!-- These are some suggestions to get you started, but feel free to write your own from scratch -->
10+
In the GitHub Discussion, we concluded that...
11+
12+
As a result, we need to...
13+
14+
Completing this work will mean...
15+
16+
**Do you think this work might require an [Architectural Decision Record (ADR)](https://github.com/json-schema-org/community/blob/main/CONTRIBUTING.md#key-architectural-decisions)? (significant or noteworthy)**
17+
18+
Yes/No
19+
[JUSTIFICATION]
20+
21+
**Work Detail**:
22+
<!-- Each item in this list may be a single Pull Request or a single PR may cover multiple -->
23+
- [ ] List of work
24+
- [ ] To be done
25+
26+
**Any further requirements to resolve this issue**

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
# - name: Ask a question
4+
# url: ./../../discussions
5+
# about: Please report security vulnerabilities here.
6+
- name: JSON Schema Slack
7+
url: https://json-schema.org/slack
8+
about: Get async support and discussion from the community and maintainers

.github/issue_template.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: General Issue
3+
about: Use this template for creating general issues
4+
---
5+
6+
<!-- If you're unsure if this issue clearly results in action, consider starting a Discussion first. -->
7+
<!-- If you have a question, please start a Discussion rather than raising an issue. -->
8+
**GitHub Discussion:** # / NA
9+
10+
**Summary**:
11+
12+
**Do you think resolving this issue might require an [Architectural Decision Record (ADR)](https://github.com/json-schema-org/community/blob/main/CONTRIBUTING.md#key-architectural-decisions)? (significant or noteworthy)**
13+
14+
Yes/No
15+
[JUSTIFICATION]
16+
17+
**Details**:
18+
19+
**Required to resolve**
20+
<!-- Please provide context followed by a checklist -->
21+
[CONTEXT]
22+
23+
- [ ] item1
24+
- [ ] item2
25+
26+
27+
**Any further requirements to resolve this issue**

.github/pull_request_template.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<!-- In order to keep off topic discussion to a minimum, it helps if the "work to be done" is already agreed on. -->
3+
<!-- Ideally, a GitHub Issue with the label `Status: Consensus` will have been concluded, and linked to in this PR. -->
4+
**GitHub Issue:** # / NA
5+
6+
**Summary**:
7+
8+
**Do you think resolving this issue might require an [Architectural Decision Record (ADR)](https://github.com/json-schema-org/community/blob/main/CONTRIBUTING.md#key-architectural-decisions)? (significant or noteworthy)**
9+
<!-- If the issue has the `adr-required`, this PR must include an ADR. -->
10+
<!-- If you do not want to include an ADR, or are not sure how to make one, make sure you allow edits to this PR by maintainers. -->
11+
12+
Yes/No
13+
[JUSTIFICATION]

0 commit comments

Comments
 (0)