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

Document the library #10

Open
viktor-yakubiv opened this issue Nov 18, 2019 · 0 comments
Open

Document the library #10

viktor-yakubiv opened this issue Nov 18, 2019 · 0 comments

Comments

@viktor-yakubiv
Copy link
Member

In the ideal world the code should be self-documented. There are couple of rules for it:

  • Do not repeat yourself
  • Every chunk of code should do only one thing
  • Code needs to be split to modules
  • Functions should have proper names

We already follow this all. Although, to extend self-documented idea I would like to suggest the following: the repository should be documented alongside with the code. In other words, imagine: you are browsing the repository and in each directory you find out docs for each component you see.

GitHub helps us with this by README.md files. It's supported natively and is displayed any time you open a directory. I would like to follow that.

Also, I suggest to get rid out from the docs directory in favour of having everything in the src.

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