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

Missing code comments #22

Open
cosmin-harangus opened this issue Nov 7, 2018 · 1 comment
Open

Missing code comments #22

cosmin-harangus opened this issue Nov 7, 2018 · 1 comment

Comments

@cosmin-harangus
Copy link

The code contains very few comments to document each functionality.
Code comments should be added on every file and public methods as well as in critical areas.
Also the size of some methods should be reduced by breaking the code down in more manageable private methods.
This would make the project easier to work on by external contributors and more maintainable in the future.

@krisboit
Copy link
Member

krisboit commented Nov 8, 2018

@cosmin-harangus thanks for stopping by :)

I agree we definitely have to do a code refactoring in some places, document the code and also documentation about the purpose of this library and how can be used.

Thanks for the feedback, if you have any other ideas we can discuss them here on github or on our moonlet dedicated channels on cryptoland.tech discord server.

As a conclusion for this issue, we can consider the main topic the code comments :)

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

2 participants