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

[ documentation, good first issue ] - README file #1

Open
tashachin opened this issue Feb 27, 2021 · 2 comments
Open

[ documentation, good first issue ] - README file #1

tashachin opened this issue Feb 27, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@tashachin
Copy link

Several questions come to mind here:

  1. I'm curious about the "base" modifier (adjective) before the dependencies. Could you clarify why you call them "base"? (This could simply be me not knowing the terminology.)
  2. I would replace the Usage header with How to Install
  3. I would clarify that the installation guide is via the command line interface (CLI). (I'm defining the initialism here just for anyone who stumbles upon this. Most devs will know what "CLI" means.)
  4. I suggest changing Folder structure to Project structure because while they are folders, there are also assets and files, therefore the entire repository is a "project".
  5. A possible enhancement is a Further Reading or Resources section for anyone new to the Node.js stack.
@taheroo
Copy link
Owner

taheroo commented Feb 27, 2021

Thank you for opening an issue about the documentation.

  1. With Base dependencies, I mean the required dependencies that will be installed to successfully run the project.

@taheroo taheroo added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 27, 2021
@tashachin
Copy link
Author

@taheroo - I think it would be easy enough for someone to edit the README on Github directly, but if you wanted to teach someone how to use Git via the CLI, you'd want to breakdown that workflow for someone.

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

2 participants