Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (50 loc) · 4.99 KB

CONTRIBUTING.md

File metadata and controls

69 lines (50 loc) · 4.99 KB

Contribution Guide

How to add a new game to the list

Please feel free to open a pull request if you know of a game that fits the list and is not mentioned here.
If you're in doubt whether a particular game is a good fit for the list, don't open an issue, but create a pull request right away because that's easier to handle. Thanks! 😃

Criteria to be accepted

Each game on the list should meet at least one of the following criteria:

  • It is a game 😃
  • You need to write some form of code/logic/procedure during the gameplay
  • It is programmable (you can control the game with code)
  • It is highly known/appreciated in the software engineering community (e.g., for its logical thinking gameplay)
  • is at least 3 months old
  • it has the key theme of technology, startups, business or software engineering in the gameplay

We do understand that complex criteria for such a list are hard. See this list as opinionated and curated. We will not merge everything right away. Depending on the game and the argumentation, we may discuss it first in the Pull Request if this is a good fit.

Games can be removed from the list if a criterion is no longer met.

What is the theme of technology, startups, business or software engineering in this context?

When it deals with things like ...

  • A simulator game of running a startup (with all the ups and downs): Mimicking the (funny) real world
  • A game where the game flow is primarily to automate activities away (with some form of logic, code, etc.)

This list is incomplete and should not limit you from adding your proposal to the list. Instead, it provides you with background on the thought process during the criteria creation.

Format

⚠️ The main README.md is a rendered version of the data. Do not edit it manually.

To add a new game, please create a .yml file in the /games directory like /games/<game-name>.yml. Feel free to check out a few other YAML files in that directory to see what it should look like.

Field Type Description
name string Name of the game
website string (url) Website (full URL) of the game
steamID integer ID of the game in the Steam Store
repository string (url) Git repository (Github, Gitlab, etc.) if the source code is publicly available
programmable boolean Can the game be controlled by code? (e.g., programmable interface for competitions)

We use the Steam ID to pull most of the data into the repository. In case your game is not offered on Steam, we are not able to pull the data. Hence this data need to be provided manually:

Field Type Description
image string (path) A path to an image of the game. The image can be placed in the repository.
platforms.windows boolean Does this game work on Windows?
platforms.mac boolean Does this game work on macOS?
platforms.linux boolean Does this game work on Linux?
release_date.date string Release date of the game (in the format of "Oct 25, 2006"). If unknown, add an empty string
english_content.short_description string A short description that tells something about this game.
english_content.genres Array Genres this came is operating in.
german_content.short_description boolean A short description that tells something about this game (in german). It is OK to leave this empty.
german_content.genres boolean Genres this came is operating in (in german). It is OK to leave this empty.

Finally, create a pull request with all your changes.

Thanks for contributing! 🎉