RFC: "Announce" entry from GitHub repository
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start with the proposed GitHub issue workflow and the existing game.json schema and file-validation requirements. Define how an automated action would import a repository into the database, report validation failures, and refer to ROMs stored in releases; no specific implementation files or tests are named.
Written by the indexing model from the issue text.
Description
So here's a simply workflow to allow a developer to submit an entry to Homebrew Hub simply "announcing" the git repository:
- The developer creates a github repository hosting all the game files / sources etc AND a
game.jsonmanifest - Developer opens an issue in the database repository mentioning he wants to add a game and links the repository
- An automated action picks up the issue and imports the folder in the database, in the current status. If the validation fails, it reports in the issue what went wrong. Validation steps:
- game.json schema validation
- file validation
Open questions:
- How can the developer refer to the ROM if it's not in the git repo but e.g. in the releases?
- Dominant language
- C
- Stars
- 95
- Forks
- 52
- Avg merge
- 7h 33m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from gbdev/database
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 35/100
-
database
Difficulty 2/5 1-3 hours Newbie friendliness 30/100
-
GBDK Gallery Opensource
Difficulty 3/5 1-2 days Newbie friendliness 25/100
-
Hardware features Openschema
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Similar issues
-
Status: Waiting triage Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
nanoframework/Home#1857 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
libsdl-org/SDL#16372 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
corazawaf/coraza-nginx#140 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100