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

Organization and Documentation of the code #31

Open
adrishyantee opened this issue Jun 11, 2021 · 2 comments
Open

Organization and Documentation of the code #31

adrishyantee opened this issue Jun 11, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@adrishyantee
Copy link
Member

We need proper documentation and organization of the code so that it can be easily understood by newcomers. Make sure that the tasks are executed within functions and comment on how they are working, This is quite a tedious thing to do as you have to go through the whole codebase line by line, but you will learn a lot through this process.

@adrishyantee adrishyantee added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers ksoc'21 labels Jun 11, 2021
@Akshit6828
Copy link

Hi did you mean we need to add comments in the code for understanding the code? Please correct me if I am wrong!

@adrishyantee
Copy link
Member Author

Hi did you mean we need to add comments in the code for understanding the code? Please correct me if I am wrong!

Yeah, you are right! Adding comments in and around functions, using proper variable names, and whatsoever makes the code look neat.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants