From da9275acf018f40783eec4fd65bc5b97aa7b46d0 Mon Sep 17 00:00:00 2001 From: Wojciech Socha Date: Thu, 14 Sep 2023 16:52:27 +0200 Subject: [PATCH 1/2] feat: add docs issue template --- .github/ISSUE_TEMPLATE/docs_error.yaml | 31 ++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/docs_error.yaml diff --git a/.github/ISSUE_TEMPLATE/docs_error.yaml b/.github/ISSUE_TEMPLATE/docs_error.yaml new file mode 100644 index 00000000..f16b24ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_error.yaml @@ -0,0 +1,31 @@ +name: API documentation error +description: Report a typo or error found in API documentation +labels: ["documentation"] +body: + - type: textarea + attributes: + label: Description of the issue + description: Description of what issue you have discovered. Please include as to why you think the issue is an issue. + validations: + required: true + - type: textarea + attributes: + label: Current content + description: What does the specification currently say? + validations: + required: false + - type: textarea + attributes: + label: Expected content + description: What do you think the specification should say instead? + validations: + required: false + - type: input + id: url + attributes: + label: Link to the documentation page + validations: + required: false + - type: markdown + attributes: + value: "Thanks for completing our form!" \ No newline at end of file From c7901eb74d11d411f5f1d3c7da5b612b441e9df6 Mon Sep 17 00:00:00 2001 From: Wojciech Socha Date: Thu, 14 Sep 2023 16:57:02 +0200 Subject: [PATCH 2/2] fix: add item reminding of including changes in compiled openapi.json file to checklist in pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8de72245..6a8f2fe9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ # Description -Please include a summary of the change and which issue is fixed. +Please include a summary of the change and which issue is fixed. If you are a Boxer, please also reference the related `DDOC` or `APIWG` tickets. If you do not have a related `Jira` ticket and this is more than a bug fix, then @@ -16,6 +16,7 @@ Re `APIWG-#` (`Jira` ticket) - [ ] I have performed a self-review of my own changes - [ ] I have run `yarn lint` to make sure my changes pass all linters - [ ] I have pulled the latest changes from the upstream developer branch +- [ ] I have run `yarn build:schema` and included changes in `openapi.json` file if any ## Contribution guidelines