Skip to content

Commit dcb850e

Browse files
committed
chore(github): bring the issue and PR templates up to date
- data_addition offered four categories; it and data_correction now offer all thirteen. data_correction asks for the category because a slug is unique only within one. - bug_report asked for a request_id and showed api.techapi.dev. There is no live server: the example is now a static API URL and the field is gone. - feature_request no longer cites a decision record and an app that nothing in this repo explains. - The PR checklist drops a review step that is not used, and CODEOWNERS drops a finished TODO. - config.yml sends engine and game issues to their own repositories. Blank issues stay enabled.
1 parent 47e84a3 commit dcb850e

7 files changed

Lines changed: 47 additions & 15 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Default owners for everything in the repo.
2-
# TODO: replace with the maintainer's GitHub handle or org team before Phase 1.
32
* @GetTechAPI/maintainers
43

54
/data/ @GetTechAPI/maintainers
Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: "🐛 Bug report"
2-
description: Report a bug in the API or tooling
2+
description: Report a bug in the static API, the site or the validator
33
labels: ["type:bug"]
44
body:
55
- type: textarea
@@ -13,9 +13,9 @@ body:
1313
id: reproduce
1414
attributes:
1515
label: Steps to reproduce
16-
description: Include the exact request (curl) where possible.
16+
description: Include the exact URL or command where possible.
1717
placeholder: |
18-
curl https://api.techapi.dev/v1/smartphones/galaxy-s25
18+
curl https://gettechapi.github.io/TechAPI/v1/smartphones/galaxy-s25/index.json
1919
validations:
2020
required: true
2121
- type: textarea
@@ -24,8 +24,3 @@ body:
2424
label: Expected behavior
2525
validations:
2626
required: true
27-
- type: input
28-
id: request-id
29-
attributes:
30-
label: request_id (if any)
31-
description: The `request_id` from the error response helps us trace it.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Collectors, verification or the API generator
4+
url: https://github.com/GetTechAPI/TechEngine/issues
5+
about: The engine that validates and publishes this data has its own repository.
6+
- name: Video games
7+
url: https://github.com/GetTechAPI/game-catalog/issues
8+
about: Game records moved to the game-catalog repository.

‎.github/ISSUE_TEMPLATE/data_addition.yml‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
name: "📥 Data addition"
2-
description: Request a new device, SoC, or GPU
2+
description: Request a record that is missing from the dataset
33
labels: ["type:data", "data:missing"]
44
body:
55
- type: dropdown
66
id: category
77
attributes:
88
label: Category
99
options:
10-
- smartphone
10+
- brand
1111
- soc
12+
- cpu
1213
- gpu
13-
- brand
14+
- smartphone
15+
- tablet
16+
- watch
17+
- pda
18+
- laptop
19+
- monitor
20+
- device_catalog
21+
- software
22+
- website
1423
validations:
1524
required: true
1625
- type: input
@@ -24,6 +33,6 @@ body:
2433
id: sources
2534
attributes:
2635
label: Source URLs (at least one)
27-
description: Manufacturer spec sheet preferred (§9.2).
36+
description: The manufacturer's product page or datasheet is preferred; a Wikipedia article also works.
2837
validations:
2938
required: true

‎.github/ISSUE_TEMPLATE/data_correction.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@ name: "✏️ Data correction"
22
description: Correct an existing spec value
33
labels: ["type:data", "data:incorrect"]
44
body:
5+
- type: dropdown
6+
id: category
7+
attributes:
8+
label: Category
9+
description: Slugs are unique only within a category.
10+
options:
11+
- brand
12+
- soc
13+
- cpu
14+
- gpu
15+
- smartphone
16+
- tablet
17+
- watch
18+
- pda
19+
- laptop
20+
- monitor
21+
- device_catalog
22+
- software
23+
- website
24+
validations:
25+
required: true
526
- type: input
627
id: slug
728
attributes:

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ body:
2020
attributes:
2121
label: Scope check
2222
options:
23-
- label: This is generalizable to all consumers (not TechPicks-specific, see ADR-008).
23+
- label: This is useful to anyone who reads the data, not only to one app or site.
2424
required: true

‎.github/pull_request_template.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
- [ ] Files live at the correct `data/<category>/<...>/<slug>.json` path
1616
- [ ] Slugs are kebab-case and unique within the category
1717
- [ ] `source_urls` cites at least one canonical reference
18-
- [ ] Sidebar filled in by hand (nothing fills it automatically): assignees, labels, milestone, projects, Copilot review, and the tracker under Development
18+
- [ ] Sidebar filled in by hand (nothing fills it automatically): assignees, labels, milestone, projects, and the tracker under Development

0 commit comments

Comments
 (0)