Skip to content
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.

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

Improve & Document Code Structure #266

Closed
1 of 3 tasks
Tracked by #246
Indy2222 opened this issue Nov 14, 2022 · 0 comments
Closed
1 of 3 tasks
Tracked by #246

Improve & Document Code Structure #266

Indy2222 opened this issue Nov 14, 2022 · 0 comments

Comments

@Indy2222
Copy link
Collaborator

Indy2222 commented Nov 14, 2022

TODO

  • Extend / update CONTRIBUTING.md to contain the following structure.
  • Adapt the code based on the guidelines.
  • Update & extend crate level documentation.

Structure

  • Game functionality is split into many small crates with hundreds to thousands SLOC.
  • Keep public API of each crate at minimum.
  • Whenever feasible, the public API consists solely of events and system labels.
    • Documentation of each event contains:
      • stage in which the event originates / is consumed
      • system label (possibly labeling multiple systems) of the systems which send/consume the event
  • Crate public API may expose components, however components may be inserted, removed or mutated solely from their respective crates.
  • event struct names end with Event
  • label enum names end with Label
@Indy2222 Indy2222 moved this to TODO in Planning Nov 14, 2022
@Indy2222 Indy2222 moved this from TODO to In Progress in Planning Nov 14, 2022
@Indy2222 Indy2222 mentioned this issue Nov 14, 2022
83 tasks
@Indy2222 Indy2222 added this to the MVP milestone Nov 15, 2022
@Indy2222 Indy2222 moved this from In Progress to TODO in Planning Nov 16, 2022
Indy2222 added a commit to Indy2222/de that referenced this issue Jan 17, 2023
Indy2222 added a commit to Indy2222/de that referenced this issue Jan 17, 2023
Indy2222 added a commit to Indy2222/de that referenced this issue Feb 6, 2023
Indy2222 added a commit to Indy2222/de that referenced this issue Feb 6, 2023
Indy2222 added a commit to Indy2222/de that referenced this issue Feb 6, 2023
@github-project-automation github-project-automation bot moved this from TODO to Done in Planning Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant