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.

Sign up for GitHub

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

Jump to bottom

Update README for Improved Contributor Guidelines #21

Closed
Evadshell opened this issue May 10, 2024 · 3 comments
Closed

Update README for Improved Contributor Guidelines #21

Evadshell opened this issue May 10, 2024 · 3 comments
Assignees
@Evadshell
Labels
good first issue Good for newcomers gssoc This label is attached to the issues related to Gssoc'24 level1

Comments

@Evadshell
Copy link
Contributor

Description:
The current README of the FoodiesWeb project lacks clear instructions for contributors, particularly regarding setting up and running the server. Currently, users need to navigate to the server directory, run npm i, and then run nodemon server.js. This process can be confusing, especially for new contributors. We need to update the README to provide clear, step-by-step instructions for setting up and running the server, possibly utilizing split terminals for better clarity.

Proposed Changes:

Revise the contributor guidelines section in the README to include clear instructions for setting up and running the server.
Provide step-by-step instructions, including navigating to the server directory, installing dependencies with npm i, and running the server with nodemon server.js.
Consider suggesting the use of split terminals for better organization and clarity during the setup process.

Expected Benefits:

-Improved onboarding experience for new contributors.
-Reduced confusion and errors during the setup and running of the server.
-Increased efficiency in development workflows.
@Evadshell
Copy link
Contributor Author

please assign this issue to me @VanshKing30 i will fix this asap

@VanshKing30 VanshKing30 added documentation good first issue Good for newcomers gssoc This label is attached to the issues related to Gssoc'24 level1 labels May 10, 2024
@VanshKing30
Copy link
Owner

@Evadshell, I'm assigning you this issue. Please solve it and create a pull request. Thanks!

Evadshell added a commit to Evadshell/FoodiesWeb that referenced this issue May 10, 2024
@Evadshell
Update README for Improved Contributor Guidelines VanshKing30#21
2ad1ae6 
Updated the README file to provide clearer instructions for contributors on setting up and running the server. Included step-by-step guidance for navigating to the server directory, installing dependencies with npm i, and running the server with nodemon server.js. Additionally, suggested the use of split terminals for better organization and clarity during the setup process. This update aims to improve the onboarding experience for new contributors, reduce confusion and errors during server setup, and increase efficiency in development workflows.
Evadshell added a commit to Evadshell/FoodiesWeb that referenced this issue May 10, 2024
@Evadshell
Update README for Improved Contributor Guidelines VanshKing30#21
1f52365 
Updated the README file to provide clearer instructions for contributors on setting up and running the server. Included step-by-step guidance for navigating to the server directory, installing dependencies with npm i, and running the server with nodemon server.js. Additionally, suggested the use of split terminals for better organization and clarity during the setup process. This update aims to improve the onboarding experience for new contributors, reduce confusion and errors during server setup, and increase efficiency in development workflows.
Evadshell added a commit to Evadshell/FoodiesWeb that referenced this issue May 10, 2024
@Evadshell
Merge pull request #1 from Evadshell/Evadshell-patch-1
246bdb8 
Update README for Improved Contributor Guidelines VanshKing30#21
@Evadshell
Copy link
Contributor Author

please check sir i've updated it!

VanshKing30 added a commit that referenced this issue May 11, 2024
@VanshKing30
Merge pull request #44 from Evadshell/patch-21
668649e 
Update README for Improved Contributor Guidelines #21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Evadshell Evadshell

Labels
good first issue Good for newcomers gssoc This label is attached to the issues related to Gssoc'24 level1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@VanshKing30 @Evadshell