New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document architecture and relevant theory in Wiki #31

Open

maxfierrog opened this issue Apr 25, 2024 · 0 comments

Labels

docs good first issue help wanted

Milestone

Member

maxfierrog commented Apr 25, 2024

Complete sections on the following topics:

Working model of games
Game categorization
Available solving algorithms and their requirements
Available interfaces and their semantics
Project architecture
In-depth development practices
- Style guidelines
- Documentation guidelines
- Collaboration guidelines
- Teamwork best practices
- Maintainers
- etc.
Guides on how to do expected tasks:
- Adding a game
- Implementing a solver
- Making a database
- Adding a command to the CLI
- Adding an interface
- etc.

This should be done in the Wiki, which is in this repository (it is also a submodule of the main GamesmanNova repository).

Recommended Courses (UC Berkeley)

This only requires you to be familiar with how things are done in the project.

maxfierrog added good first issue help wanted better engineering docs and removed better engineering labels

BnjmnZmmrmn added this to the v1.0.0 release milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment