Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/tooling.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading