CONTRIBUTING.md

How to contribute to Cardio

Thanks for contributing to Cardio! 🙏

Contributing as a non-developer, i.e., as a player

• Please play the game.
• Provide feedback:
  • Report bugs in Issues.
  • Add new ideas or discuss and vote on existing ideas in Discussions.

Contributing as a developer, designer, level designer, etc.

Start by reading DOMAIN and the file you're currently reading. That should give you a first overview of the project. Then, pick from the following options:

• Resolve Issues.
• Pick ideas from Discussions, turn them into Issues and implement them.
• Contribute in Discussions. Especially anything around improving software architecture.
• Look for the "good first issue" label in both issues and discussions to get started.

Specific areas to work on

• New locations and skills.
• Introduce items?
• Improve computer strategy, make it more elaborate.
• Improve the current UI (aka TUI, terminal user interface).
• Add new user interfaces, e.g., a web-based interface.

Contribution workflow

1. Fork the repo and create your branch from main.
2. If you've added code that should be tested, add tests.
3. Add docstrings and comments as necessary and reasonable.
4. Adapt/extend DOMAIN.md if necessary.
5. If you added a new skill, make sure to work through the checklist at the top of skills.py.
6. Ensure the test suite passes. (Run pytest.)
7. Use black to format your code.
8. Issue a pull request.

Todo labels in the code

Use the following labels in the code to mark todos:

• TODO: High priority todos
• FIXME: Todos in general.
• QQ: Questions, low-prio todos, etc.

Look for these to see what needs to be done.

(Consider using vscode's "todo tree" extension to get an overview of all todos in the code.)

License

• Cardio is licensed under the GPLv3 license. See LICENSE for details.
• By contributing, you agree that your contributions will be licensed under the same license.