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] : Update readme #3

Open
PritamSarbajna opened this issue Aug 13, 2022 · 16 comments · Fixed by #42
Open

[DOCS] : Update readme #3

PritamSarbajna opened this issue Aug 13, 2022 · 16 comments · Fixed by #42
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@PritamSarbajna
Copy link
Owner

update the readme with latest previews.

@PritamSarbajna PritamSarbajna added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Aug 13, 2022
@Seyi-Ojo
Copy link
Contributor

Hi, I saw your project and wondered if I could work on it. But first, could you please elaborate on what I should do?

@PritamSarbajna
Copy link
Owner Author

Hey @Seyi-Ojo this is a frontend project. Do you need any help to get started with this project ?? or are you searching for any issue to work on ?

@Seyi-Ojo
Copy link
Contributor

Hello @PritamSarbajna Yes please, I need an issue to work on.

@PritamSarbajna
Copy link
Owner Author

Hey @Seyi-Ojo you can choose this issue it needs to only update the readme with the current screenshot of the website. also do you know how to make a PR and fork and all that If you don't or any other help feel free to ask me. Also here is my discord username Pritam_Sarbajna#8032

@Seyi-Ojo
Copy link
Contributor

Thank you very much Pritam, I know how to make a PR and fork but I would still ask for help when I need to, thank you so much.

@PritamSarbajna
Copy link
Owner Author

@Seyi-Ojo yeah sure and if you're beginner in development and open source then I think this repo can be best for you !

@Techkrish1
Copy link

Can you assign me to improve the README.md?

@Seyi-Ojo
Copy link
Contributor

Hey Pritam, so I checked the README.md file and saw that I am to add a screenshot, how do I go about this? I am trying to learn with this, so I need you to explain what I should do. Thank you.

@PritamSarbajna
Copy link
Owner Author

Hey @Seyi-Ojo just learn this first : tutorial

After that you will understand how to fork and all then please let me know so that we can move further

Repository owner deleted a comment from Seyi-Ojo Aug 19, 2022
@PritamSarbajna
Copy link
Owner Author

PritamSarbajna commented Aug 19, 2022

Don't comment similar thing again if you don't receive reply please have patience.

@PritamSarbajna
Copy link
Owner Author

Hey @Seyi-Ojo the readme needs update because the website's UI has been changed

@Seyi-Ojo
Copy link
Contributor

Okay, I will redo it @PritamSarbajna

@PritamSarbajna
Copy link
Owner Author

Yeah sure @Seyi-Ojo

@Shreyashkshirsagar
Copy link
Contributor

I believe that improving the documentation in the README file will not only enhance the project's usability but also make it more accessible to newcomers and existing users. My experience in documentation and attention to detail would be beneficial in ensuring that the README is clear and informative.
Before I proceed, I wanted to confirm whether you would be comfortable with me taking on this task. If so, I will start working on it promptly and ensure that the updated documentation aligns with the project's objectives.

@PritamSarbajna
Copy link
Owner Author

Yeah @Shreyashkshirsagar, work on it 🚀

@Shreyashkshirsagar
Copy link
Contributor

I Have Completed the assigned Work and I have created an entirely new README File , @PritamSarbajna I Want you to review it and accept the pull request.
As Soon as Possible.

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 enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants