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

Refactor modules into to folders and provide basic documentation for each module #52

Open
finnhartshorn opened this issue Sep 5, 2024 · 0 comments
Milestone

Comments

@finnhartshorn
Copy link
Member

finnhartshorn commented Sep 5, 2024

Currently each module is just a single file with at times over 2000 lines in it. We need to refactor some of the larger modules into a folder with sub modules. We should also start to document each module and any key structs/methods.

The contributing.md should suggest reading the docs and joining the discord firstly and also contain some useful suggestion on how to structure things and link in with the rest of the codebase.

@finnhartshorn finnhartshorn added this to the 0.1.0 milestone Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant