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

Improve Documentation #17

Open
deepanshu-rawat6 opened this issue Jul 5, 2023 · 4 comments
Open

Improve Documentation #17

deepanshu-rawat6 opened this issue Jul 5, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation easy Task suited for beginners devs good first issue Good for newcomers

Comments

@deepanshu-rawat6
Copy link
Member

No description provided.

@deepanshu-rawat6 deepanshu-rawat6 added documentation Improvements or additions to documentation good first issue Good for newcomers easy Task suited for beginners devs labels Jul 5, 2023
@karthiknadar1204
Copy link

I would like to work on this issue under osoc'23.
Here i propose to make the readme elaborate by adding an elaborate way to open a pr and set up the project as well as shell commands so that anyone starting out with the project can start out easily

@deepanshu-rawat6
Copy link
Member Author

Yes @karthiknadar1204 , I'll be happy to assign you this issue. But, we'll stress on creating documentation in the last three days of the project, so we can't really assign this issue as of now.

Sure, you can try to contribute via others issue, best of luck✨

@karthiknadar1204
Copy link

Ah,i insist on adding the process to open a pr as any new contributor might have a hard time navigating ,should I open a separate issue then?

@deepanshu-rawat6
Copy link
Member Author

Yes @karthiknadar1204 , I'll create an issue and then assign it to you. Make sure you create a proper descriptive CONTRIBUTING.MD file in the root of this repository, along with some images which would help new contributors.

Plus point: Add some git commands, some more insights on fetching and pull changes

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 easy Task suited for beginners devs good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants