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

[Feature]: Clearer codebase and documentation #15

Open
4 tasks
staeter opened this issue Jun 15, 2022 · 0 comments
Open
4 tasks

[Feature]: Clearer codebase and documentation #15

staeter opened this issue Jun 15, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation minor Minor update (release)

Comments

@staeter
Copy link

staeter commented Jun 15, 2022

Description

They are some legacy files and folder organization that would gain from being restructured or deleted and the code would gain by having a bit of documentation (mostly in the Readme.md). Because one of the objectives of this repo is to serve as a base for people that would want to take part in the competition.

Expected behaviour

It should be possible for someone new to understand what's happening in this repo.

Environment

any

Proposed solution

  • Write some better explanation of what's done on this repo in the Readme.md
  • Write some setup explanation in Readme.md
  • Reorganize files with explicit folder names
  • Delete legacy code
@staeter staeter added the triage Need to be tagged label Jun 15, 2022
@staeter staeter added documentation Improvements or additions to documentation minor Minor update (release) and removed triage Need to be tagged labels Jun 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation minor Minor update (release)
Projects
None yet
Development

No branches or pull requests

2 participants