From de7c38e061e022ac1066d15c952e051ad53584d6 Mon Sep 17 00:00:00 2001 From: Ben Hutton Date: Tue, 17 Aug 2021 15:44:22 +0100 Subject: [PATCH 1/5] Add very basic issue template --- .github/ISSUE_TEMPLATE/default.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/default.md diff --git a/.github/ISSUE_TEMPLATE/default.md b/.github/ISSUE_TEMPLATE/default.md new file mode 100644 index 00000000..77eb40a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/default.md @@ -0,0 +1,18 @@ +--- +name: Work item +about: Use this template for creating work to be done in relation to a GitHub Discussion +--- + +GitHub Discussion: # + +Work Summary: + + +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 + +Work Detail: + + - List of work + - To be done \ No newline at end of file From d3ae434d437a5b9424833b8619809571151cc70d Mon Sep 17 00:00:00 2001 From: Ben Hutton Date: Wed, 18 Aug 2021 15:53:21 +0100 Subject: [PATCH 2/5] Add further default and action item issue templates --- .github/ISSUE_TEMPLATE/action_item.md | 25 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++++++ .github/ISSUE_TEMPLATE/default.md | 18 ------------------ .github/issue_template.md | 26 ++++++++++++++++++++++++++ 4 files changed, 59 insertions(+), 18 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/action_item.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/default.md create mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/action_item.md b/.github/ISSUE_TEMPLATE/action_item.md new file mode 100644 index 00000000..c522f6cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/action_item.md @@ -0,0 +1,25 @@ +--- +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**: + +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 + +**Work Detail**: + +- [] List of work +- [] To be done + +**Any further requirements to resolve this issue** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..5e760162 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/default.md b/.github/ISSUE_TEMPLATE/default.md deleted file mode 100644 index 77eb40a8..00000000 --- a/.github/ISSUE_TEMPLATE/default.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Work item -about: Use this template for creating work to be done in relation to a GitHub Discussion ---- - -GitHub Discussion: # - -Work Summary: - - -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 - -Work Detail: - - - List of work - - To be done \ No newline at end of file diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 00000000..190b2f36 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,26 @@ +--- +name: General Issue +about: Use this template for creating general issues +--- + + + +**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 + +**Details**: + +**Required to resolve** + +[CONTEXT] + +- [ ] item1 +- [ ] item2 + + +**Any further requirements to resolve this issue** From 68c4f1fbb52edba8c3e30ebfa7450a3d79a2204e Mon Sep 17 00:00:00 2001 From: Ben Hutton Date: Thu, 19 Aug 2021 10:18:20 +0100 Subject: [PATCH 3/5] Add Pull Request template and add space for justification as to requireing ADR or not --- .github/ISSUE_TEMPLATE/action_item.md | 1 + .github/issue_template.md | 1 + .github/pull_request_template.md | 11 +++++++++++ 3 files changed, 13 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/action_item.md b/.github/ISSUE_TEMPLATE/action_item.md index c522f6cf..f82150dc 100644 --- a/.github/ISSUE_TEMPLATE/action_item.md +++ b/.github/ISSUE_TEMPLATE/action_item.md @@ -16,6 +16,7 @@ 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**: diff --git a/.github/issue_template.md b/.github/issue_template.md index 190b2f36..3f9a5237 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -12,6 +12,7 @@ about: Use this template for creating general issues **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**: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..46ebe289 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ + +**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)** + + + +Yes/No +[JUSTIFICATION] \ No newline at end of file From 9e9348a102b19914a5e75d4cfcfab0e29cc5b76a Mon Sep 17 00:00:00 2001 From: Ben Hutton Date: Thu, 19 Aug 2021 11:25:19 +0100 Subject: [PATCH 4/5] Add comment to PR template to explain why we want an issue ID --- .github/pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 46ebe289..374baf8f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,6 @@ + + **GitHub Issue:** # / NA **Summary**: From ec81d3e7a02a818dcb87606346d5fdedf6a17cc8 Mon Sep 17 00:00:00 2001 From: Ben Hutton Date: Thu, 19 Aug 2021 11:31:57 +0100 Subject: [PATCH 5/5] Fix checkbox lists Checkbox lists must have space between square brackers --- .github/ISSUE_TEMPLATE/action_item.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/action_item.md b/.github/ISSUE_TEMPLATE/action_item.md index f82150dc..4d9dd04a 100644 --- a/.github/ISSUE_TEMPLATE/action_item.md +++ b/.github/ISSUE_TEMPLATE/action_item.md @@ -20,7 +20,7 @@ Yes/No **Work Detail**: -- [] List of work -- [] To be done +- [ ] List of work +- [ ] To be done **Any further requirements to resolve this issue**