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

Need for Documentation #28

Open
SVijayB opened this issue Mar 30, 2021 · 0 comments
Open

Need for Documentation #28

SVijayB opened this issue Mar 30, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@SVijayB
Copy link
Member

SVijayB commented Mar 30, 2021

Need for Documentation

  • The entire project must be documented.
  • Changelog must be created and constantly updated for future developers.
  • Contributing guidelines must be set for developers to understand how to contribute to the project.
  • README.md must be updated with project details like, why and how to install it along with other essential details.
  • Automating changelog based on commit messages is also recommended.
  • Adding in Issue and pull request templates for ease of contributing is also required.

For any help with documentation or understanding the scripts, contact the developers.
Front-end -> @iamvineettiwari
Back-end -> @AshutoshSingh-123, @tahajunaid and @Susmita-Pal.

@SVijayB SVijayB added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 30, 2021
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants