-
Notifications
You must be signed in to change notification settings - Fork 307
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
Define default model for naming and commenting code #84
Comments
I was looking at some code and it was quite hard for me to understand what it was that the code was doing, and since this repo has an intention of teaching/provide knowledge, I think it's fundamental that we make our code crystal clear to everybody! |
@sirjan13 @alexandrebarbaruiva |
i would also like to invite @Vehemos @achaJackson @aman935 to this issue :) |
I suggest that for every folder with program, there should have a readme with the name of the program and description (complexity, how it works, etc), this way we can have a deep understanding of all that happens in that particular folder |
@alexandrebarbaruiva |
Hi, |
As you all know, as code complexity goes up, readability usually goes down. Therefore, it's vital that we unify our way of commenting and naming things
The text was updated successfully, but these errors were encountered: