Add CONTRIBUTING.md. #108
Add CONTRIBUTING.md. #108
Conversation
Co-authored-by: Tom <25043847+Douile@users.noreply.github.com>
|
It might also be worth adding rules for the "full name" of games e.g.
|
|
Great catch, generalized it a bit. |
CONTRIBUTING.md
Outdated
| 7. If a game has multiple id entries (by specifying the edition (Minecraft: | ||
| Java and Bedrock) or the release version (Counter-Strike 1: 1.5 and 1.6)), one | ||
| more entry by the base name (`minecraft` and `counterstrike` respectively) can | ||
| be added, where it queries in a group said included entries. |
There was a problem hiding this comment.
This mentions the case for the auto query but doesn't tell us what to do for individual protocols. Should we stop adding ids for individual protocols e.g. minecraftjava?
Or should that already be included as a word anyway. I have been leaving out because the protocol is wrapped in (), which is similar to how the year is extra info, but games could included () in their titles anyway.
Perhaps adding the protocol should be specified in name rules.
There was a problem hiding this comment.
Modified, what do you think?
There was a problem hiding this comment.
That's good for the ID I think, we should also mention whether the protocol is to be added to the pretty name though.
An attempt to implement the rules specified in gamedig#108 as a programmatic test.
An attempt to implement the rules specified in gamedig#108 as a programmatic test.
An attempt to implement the rules specified in gamedig#108 as a programmatic test.
An attempt to implement the rules specified in gamedig#108 as a programmatic test.
An attempt to implement the rules specified in gamedig#108 as a programmatic test.
An attempt to implement the rules specified in gamedig#108 as a programmatic test.
* [Test] Add best effort test to validate game ID rules An attempt to implement the rules specified in #108 as a programmatic test. * [Test] Refactor ID rules to check if a mod exists after - in game name This allows fivem to pass the check following rule 8, but could also cause a false pass in some cases. * [Test] Add unit tests for ID rule checker Adds unit tests based on the examples in CONTRIBUTING.md to confirm in those cases we would allow ID to pass. However these tests don't check any error cases. * test/id: Correctly extract protocol names * games/defs: Fix unreal tournament IDs * tests: Require game definitions to run ID tests * tests: Improve comments on ID tests * tests/id: Combine - seperated numbers * games/defs: Fix darkest hour ID * Add/Update badge --------- Co-authored-by: GitHub Action <action@github.com>
Adds initial CONTRIBUTING file with some basics I came up with.
More importantly, also the naming of the new games id system (suggested one).
I'm very open to discussions regarding anything and everything in this file.