Define default model for naming and commenting code

[alexandrebarbaruiva]

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

[alexandrebarbaruiva]

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!

[srbcheema1]

thanks for creating the issue 👍
similar issue was started by @sirjan13 in issue #63
this would be great to create some rules and measures to make the code readable and understandable

[srbcheema1]

@sirjan13 @alexandrebarbaruiva
lets first of all discuss on how this model should be .
also we will create a code_model.md for the contributers

[srbcheema1]

i would also like to invite @Vehemos @achaJackson @aman935 to this issue :)

[alexandrebarbaruiva]

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

[srbcheema1]

@alexandrebarbaruiva
@sirjan13
i have added a CONTRINUTION.md file have a look at it .
also add more to it 😄

[Krishna-rudraksh70]

Hi,
I'm looking for issue to contribute to in Hacktoberfest. I noticed an issue in your repository regarding the "Define default model for naming and commenting code". I would like to request the opportunity to work on this issue.