mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-11-05 01:23:45 -06:00
docs: put the project's working rules in the wiki
Principles, collection rules and the inverted model in architecture.md, research and citation rules in profiling.md, platform and scraper rules in their pages, tool conventions in tools.md, test and commit expectations in testing-guide.md, installer constraints in installer.md. Each rule sits where a reader looks for it, with its reason. Also fixes the stale release-job line, the suite command without -t ., and the unsourceable definition.
This commit is contained in:
1 parent
392aacb207
commit
348c56e94c
9 files changed
+407
-10
No files matched your search
@@ -211,6 +211,16 @@ System ID consistency matters for cross-platform operations. The same console mu
|
||||
|
||||
Scraped data reflects what the upstream declares, which may not match reality. The scraper's job is faithful transcription of upstream data, not correction. Corrections happen in the emulator profiles (source-verified) and in `_shared.yml` (curated). If a scraper meets a hash or filename that differs from the emulator source, log a warning and still include the upstream value. The divergence will surface during truth diffing.
|
||||
|
||||
A few rules keep that transcription honest:
|
||||
|
||||
- An entry the upstream file does not carry is marked: `shared_group`,
|
||||
`mirror_of` or `curated`. Unmarked, it would be counted and exported as
|
||||
something the platform declares.
|
||||
- A scraper that reads nothing raises. An empty input (a refused API call, a
|
||||
moved file) must not rewrite a platform or target file as empty.
|
||||
- Names that YAML would turn into numbers or dates are written quoted, so the
|
||||
next scrape produces the same file.
|
||||
|
||||
## Creating a target scraper
|
||||
|
||||
Target scrapers determine which emulator cores are available on each hardware
|
||||
|
||||
Reference in new issue
Block a user