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

shethshlok #87

Closed
connman4027 opened this issue Sep 2, 2024 · 3 comments
Closed

shethshlok #87

connman4027 opened this issue Sep 2, 2024 · 3 comments
Assignees

Comments

@connman4027
Copy link

The Readme file is currently lengthy and complex, making it challenging for newcomers to comprehend how to contribute effectively to the project.

To enhance accessibility and clarity, I propose relocating the Contributing section to the beginning of the Readme file and streamlining its content where feasible.

I kindly request assistance from anyone willing to dedicate time to address this issue and improve the project's accessibility for all contributors. Thank you!

@shethshlok
Copy link
Collaborator

Hello Developers, My name is Shlok Sheth, I am a full stack developer completing my masters in Computer Science at Northern Arizona University, in Flagstaff. I am in enrolled in CS 599 - Open Source Development class. This is is my first issue in this repository and my goal is to resolve and redefine the README file so that user and new visitors have a clear idea about the project especially the contributing section.

@shethshlok
Copy link
Collaborator

shethshlok commented Sep 12, 2024

Hey @caiton1, I would appreciate your advise, given your contribution to this project and expertise, could you recommend me any specific changes I should make to the README file. Here is what I think:

  1. Shift the Contributing section to the top.
  2. Add more images or flow chart to the read me to explain it to a new visitor
  3. Add installation instruction for different operating systems.

I will work on the 1st one, create another issue if you want me to work on other two.

@shethshlok
Copy link
Collaborator

I have resolved the issue and filed a pull request #109

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants