Skip to content

Commit

Permalink
Replace "installs" and "opens" requirements with PR proposal - make t…
Browse files Browse the repository at this point in the history
…hem simplier
  • Loading branch information
mattmaniak committed Jul 8, 2024
1 parent 26debf4 commit fb8f39e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ Documentation for Whisky.
- Ensure proper grammar, capitalization, spelling, spacing, and general professionalism. Jokes and such are allowed, but lets prioritize helping others before all else.
- Ensure accuracy. Don't upload misleading information, false reports, guesses, or improper research.
- Cite your sources. Found a guide from somewhere else? Found a solution or other thing online? Provide a link in your page. This isn't a requirement that's going to get your PR rejected, but simply one that future-proofs things and ensures that if a game suddenly breaks, we can check our sources and see if there are any updates to the solutions found.
- Write whether a game installs without any errors and opens properly according to the parameters in an example below. Set `opens` to `Yes` only if a game launches successfully to it's default screen, eg. main menu or initial gameplay if it lacks a main menu. Any crash, freeze or error before this breakpoint means that the game does not open and it should be filled with `opens=No`.
- Document the installation process and any errors that arise during the installation. If installation fails, set `installs=No` in the `Ratings` template.
- Document whether a program opens by setting `opens=Yes` in the `Ratings` template. A program is considered "open" if it launches the title screen or main menu. Dialog messages don't count as a program "opening".
- Add status ratings to your game based on the following scale. We leave this up to general author interpretation, but please make sure you're still following these general guidelines:

| Status | Description |
Expand Down

0 comments on commit fb8f39e

Please sign in to comment.