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

[DOCS] <Better ReadMe to explain the project> #18

Open
krupalitrivedi opened this issue Aug 20, 2022 · 2 comments
Open

[DOCS] <Better ReadMe to explain the project> #18

krupalitrivedi opened this issue Aug 20, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@krupalitrivedi
Copy link

Description

Greetings.
Here are a few changes that can be made in the documentation according to me.

  • ReadMe can be updated to provide more information about the project.
  • Prerequisites needed for contribution can be added
  • Tech Stack can be added
  • Is the project open for others to run it on their machine?
  • You can mention the installation steps for people to run it on their local machine or online.

Screenshots

No response

Additional information

No response

@krupalitrivedi krupalitrivedi added the documentation Improvements or additions to documentation label Aug 20, 2022
@nathgoutam93
Copy link
Owner

Right now the installation steps are mentioned in the contribution guidelines.

With the intention of, If someone is interested to contribute they will read the contribution guidelines and from there, they will able to readi how to install and make pull request.

Yup, the Tech Stack is missing in the documentation.

@krupalitrivedi
Copy link
Author

Alright! That seems fine to me :)

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
Projects
None yet
Development

No branches or pull requests

2 participants