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
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

## Checklist

- [ ] The PR targets `develop` (`main` only moves through release PRs)
- [ ] `python -m app.validate` passes locally
- [ ] Files live at the correct `data/<category>/<...>/<slug>.json` path
- [ ] Slugs are kebab-case and unique within the category
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/bump-engine.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ concurrency:

jobs:
bump:
# Org-only: this job publishes the site or talks to TechEngine. In a fork
# it can only fail (no secrets, no Pages), so it does not run there.
if: github.repository == 'GetTechAPI/TechAPI'
runs-on: ubuntu-latest
env:
ENGINE_TOKEN: ${{ secrets.ENGINE_TOKEN }}
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ concurrency:

jobs:
build:
# Org-only: this job publishes the site or talks to TechEngine. In a fork
# it can only fail (no secrets, no Pages), so it does not run there.
if: github.repository == 'GetTechAPI/TechAPI'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/notify-engine.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ permissions:

jobs:
notify:
# Org-only: this job publishes the site or talks to TechEngine. In a fork
# it can only fail (no secrets, no Pages), so it does not run there.
if: github.repository == 'GetTechAPI/TechAPI'
runs-on: ubuntu-latest
env:
ENGINE_TOKEN: ${{ secrets.ENGINE_TOKEN }}
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,14 @@ submodule bump and the verified-promotion bot both land on `develop`.

## Contributing

Open a PR **against `develop`** with the new/updated JSON file. The PR template
walks through what to include. The validator must pass. All records (`brand`,
`soc`, `smartphone`, `gpu`, and `cpu`) must include `source_urls` with at least
one canonical reference (vendor product page, Wikipedia infobox, datasheet).
Open a PR **against `develop`** with the new/updated JSON file — that is also
the default branch, so a PR from a fork targets it automatically. The PR
template walks through what to include, and the validator must pass. Every
record, in every category, must include `source_urls` with at least one
canonical reference (vendor product page, Wikipedia infobox, datasheet).

## License

Data is licensed **CC-BY-SA 4.0**; attribute "Data from TechAPI" and share alike.
Data is licensed **CC-BY-SA 4.0**; attribute "Data from TechAPI" and share alike
(see [`data/LICENSE.md`](data/LICENSE.md)).
The bundled validator code is [MIT](LICENSE).
15 changes: 15 additions & 0 deletions data/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Data license

The dataset in this directory (`data/**`), and the static JSON API generated
from it (`site/public/v1/**`), are licensed under **Creative Commons
Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)**:
<https://creativecommons.org/licenses/by-sa/4.0/>

When you reuse the data, attribute it as "Data from TechAPI" with a link to
<https://github.com/GetTechAPI/TechAPI>, and release derived datasets under the
same license. Each record also lists the sources it was compiled from in its
`source_urls` field.

This notice restates the license declared in the top-level `README.md`. The
code in this repository — the validator, the site and the workflows — is
licensed separately under MIT; see [`../LICENSE`](../LICENSE).
Loading