From 3535960d158b9648a32a0a7bb0c5ee475ab21492 Mon Sep 17 00:00:00 2001 From: minutechreview <141821420+minutechreview@users.noreply.github.com> Date: Tue, 27 Oct 2026 13:15:44 +0300 Subject: [PATCH] Add a tooling/docs issue form and an issue chooser link to CONTRIBUTING.md (#1207) Signed-off-by: minutechreview <141821420+minutechreview@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/tooling.yml | 53 ++++++++++++++++++++++++++++++ README.md | 4 ++- 3 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/tooling.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..5acac292 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Contributing guide + url: https://github.com/yakew7/Fair-Code/blob/main/CONTRIBUTING.md + about: Read this before you claim an issue or open a pull request. diff --git a/.github/ISSUE_TEMPLATE/tooling.yml b/.github/ISSUE_TEMPLATE/tooling.yml new file mode 100644 index 00000000..f0bbb233 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tooling.yml @@ -0,0 +1,53 @@ +name: Tooling or docs request +description: A script, CI, test or documentation change that is not an audit or explainer +labels: ["tooling"] +body: + - type: markdown + attributes: + value: | + Use this for scripts, CI, tests and docs. Name the file, say what is missing or wrong, and say how we will know it is done. + + - type: input + id: where + attributes: + label: Where + description: The file or files the change is in. + placeholder: e.g. scripts/check_external_links.py + validations: + required: true + + - type: textarea + id: current-gap + attributes: + label: Current gap + description: What is missing or wrong today. Paste a command and its output if you can reproduce it. + placeholder: | + e.g. An ignored URL that is later removed from every document stays in the ignore list and nothing reports it. + validations: + required: true + + - type: textarea + id: suggested-approach + attributes: + label: Suggested approach + description: How you would fix it. Optional if you are not sure yet. + placeholder: e.g. Report ignored URLs that no checked file contains as stale ignore entries. + validations: + required: false + + - type: textarea + id: done-when + attributes: + label: Done when + description: What has to be true for the issue to be closed, such as a passing test or a command's output. + placeholder: e.g. A test shows a stale entry listed, and the weekly issue mentions the count. + validations: + required: true + + - type: checkboxes + id: checklist + attributes: + label: Before you submit + options: + - label: My contribution is em-dash-free - I used hyphens ( - ) instead of em dashes in all files + required: true diff --git a/README.md b/README.md index af3d4045..778a5cdf 100644 --- a/README.md +++ b/README.md @@ -131,8 +131,10 @@ Fair-Code/ │ │ └── codeql-config.yml │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.yml +│ │ ├── config.yml │ │ ├── new_audit.yml -│ │ └── new_explainer.yml +│ │ ├── new_explainer.yml +│ │ └── tooling.yml │ └── workflows/ │ ├── audits.yml # CI: runs all audit scripts on every push/PR │ ├── benchmark-diff.yml # opt-in: reruns the benchmark on a lockfile-bump PR and comments the diff