Skip to content

Commit

Permalink
Merge pull request #36 from Relequestual/feature/adr-templates
Browse files Browse the repository at this point in the history
Add Issue and Pull Request templates, mainly for ADRs
  • Loading branch information
Relequestual authored Nov 23, 2021
2 parents 8df1c76 + ec81d3e commit da29cd7
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/action_item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Action Item
about: Use this template for creating work to be done, usually in relation to a GitHub Discussion
---

**GitHub Discussion:** # / NA

**Work Summary**:
<!-- These are some suggestions to get you started, but feel free to write your own from scratch -->
In the GitHub Discussion, we concluded that...

As a result, we need to...

Completing this work will mean...

**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)**

Yes/No
[JUSTIFICATION]

**Work Detail**:
<!-- Each item in this list may be a single Pull Request or a single PR may cover multiple -->
- [ ] List of work
- [ ] To be done

**Any further requirements to resolve this issue**
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
# - name: Ask a question
# url: ./../../discussions
# about: Please report security vulnerabilities here.
- name: JSON Schema Slack
url: https://json-schema.org/slack
about: Get async support and discussion from the community and maintainers
27 changes: 27 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: General Issue
about: Use this template for creating general issues
---

<!-- If you're unsure if this issue clearly results in action, consider starting a Discussion first. -->
<!-- If you have a question, please start a Discussion rather than raising an issue. -->
**GitHub Discussion:** # / NA

**Summary**:

**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)**

Yes/No
[JUSTIFICATION]

**Details**:

**Required to resolve**
<!-- Please provide context followed by a checklist -->
[CONTEXT]

- [ ] item1
- [ ] item2


**Any further requirements to resolve this issue**
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

<!-- 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. -->
**GitHub Issue:** # / NA

**Summary**:

**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)**
<!-- If the issue has the `adr-required`, this PR must include an ADR. -->
<!-- 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. -->

Yes/No
[JUSTIFICATION]

0 comments on commit da29cd7

Please sign in to comment.