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: check for typos and grammar issues all the markdown files #48

Closed
9 tasks done
ashuvssut opened this issue Oct 2, 2022 · 20 comments · Fixed by #119
Closed
9 tasks done

docs: check for typos and grammar issues all the markdown files #48

ashuvssut opened this issue Oct 2, 2022 · 20 comments · Fixed by #119
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest Issues that are open for hacktoberfest contributors UP FOR GRABS Issues open to new assignees

Comments

@ashuvssut
Copy link
Member

ashuvssut commented Oct 2, 2022

Description

Check for typos/ captalization and grammar issues all the markdown files. Restrucutre sentences wherever you feel if necessary (see changes of PR #81 for reference). Keep the sentences CONCISE and SIMPLE

There are 9 markdown files.

  • one README.md file
  • rest 8 markdown files are in .docs/

Please do mention which one you are going to work on to avoid the possibility of 2 people working on the same markdown file. Pick up which doc page you are gonna work on and tell me before you start working. I will update the list below


Current Progress

@ashuvssut ashuvssut added documentation Improvements or additions to documentation hacktoberfest Issues that are open for hacktoberfest contributors labels Oct 2, 2022
@giftade
Copy link
Contributor

giftade commented Oct 2, 2022

I'd like to try this

@iatharva
Copy link

iatharva commented Oct 2, 2022

Hi, Can I work on this @ashuvssut ?

@ashuvssut
Copy link
Member Author

This issue will be always open. Its for anyone who can find flaws in the docs. But, this issue will assigned on first-come, first-serve basis (ref contributing guidelines).

@ashuvssut
Copy link
Member Author

ashuvssut commented Oct 2, 2022

@iatharva you can pickup other .md files.

Read Issue description once

@dejmedus
Copy link
Contributor

dejmedus commented Oct 3, 2022

Hi, I can take a look at some unassigned docs pages when iatharva is finished

@ashuvssut
Copy link
Member Author

ashuvssut commented Oct 3, 2022

@dejmedus go through the top issue description. only 2 pages are done. no one is working currently. assign yourself any doc page you want. do tell which one you are working on. I will update the description

@dejmedus
Copy link
Contributor

dejmedus commented Oct 5, 2022

Sounds good, I will work on contributing.md then

@Asmi-1
Copy link
Contributor

Asmi-1 commented Oct 6, 2022

I want to work on CODE-OF-CONDUCT.md

@Asmi-1
Copy link
Contributor

Asmi-1 commented Oct 6, 2022

I want to work on GIT-GUIDELINES.MD

@ashuvssut ashuvssut pinned this issue Oct 7, 2022
@ashuvssut ashuvssut added the UP FOR GRABS Issues open to new assignees label Oct 7, 2022
@dejmedus
Copy link
Contributor

dejmedus commented Oct 7, 2022

I will look over the project-structure.md

@ashuvssut
Copy link
Member Author

ashuvssut commented Oct 7, 2022

@dejmedus @Pratham-Mishra178 @Asmi-1 if you are interested to do more PRs in this, then there are 3 more markdown files remaining (see description)

@Pratham-Mishra178
Copy link
Contributor

@dejmedus @Pratham-Mishra178 if you are interested do more PRs in this, then there are 3 more markdown files remaining (see description)

okay sure, looking into it

@Asmi-1
Copy link
Contributor

Asmi-1 commented Oct 7, 2022

I want to work on PROJECT-GUIDELINES.md

@Asmi-1
Copy link
Contributor

Asmi-1 commented Oct 7, 2022

I want to work on STYLE-GUIDE.md

@Asmi-1
Copy link
Contributor

Asmi-1 commented Oct 7, 2022

I want to work on README.md

@ashuvssut
Copy link
Member Author

@Asmi-1 you can work on 2 PRs at a time.

Take PROJECT-GUIDELINES.md + README.md

@Pratham-Mishra178
Copy link
Contributor

I want to work on STYLE-GUIDE.md

@ashuvssut
Copy link
Member Author

@Pratham-Mishra178 please read issue description carefully before starting.

@Pratham-Mishra178
Copy link
Contributor

Ok, sure

@ashuvssut
Copy link
Member Author

This issue can be reopened if you want to contribute to this issue

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 hacktoberfest Issues that are open for hacktoberfest contributors UP FOR GRABS Issues open to new assignees
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants