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 exisiting README #195

Closed
Aryamanz29 opened this issue Oct 2, 2022 · 4 comments · Fixed by #203
Closed

[docs] Update exisiting README #195

Aryamanz29 opened this issue Oct 2, 2022 · 4 comments · Fixed by #203
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest

Comments

@Aryamanz29
Copy link
Owner

  • I found some of the section in project README have errors that need to be correct and I'm also thinking of improving overall project README.
  • Some of the errors are shown below :
1. git pull upstream main (correction : we are using master as default branch)

2. Write commit message as "Small Message" 

git commit -m "Write a meaningfull but small commit message" 

(correction: better to mention proper commit message guidelines to maintain consistency, I would suggest to use : (https://www.conventionalcommits.org/en/v1.0.0/))

There are lots of area for improvement, let me know more in issue thread before proceeding further :)

@Aryamanz29 Aryamanz29 added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest labels Oct 2, 2022
@akhilsharmaa
Copy link

I like to work on this.

@adityasingh10042
Copy link
Contributor

Hey, I want to work on this. Please assign this to me!

@Aryamanz29
Copy link
Owner Author

@adityasingh10042 Go ahead 👍🏻

@Aryamanz29
Copy link
Owner Author

@akhilsharmaa I have opened a general issue for all here : #198, Please read issue description carefully and send us PR :)

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 hacktoberfest
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants