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

README.md file enhancement. #333

Closed
anirudhsai20 opened this issue Feb 26, 2021 · 2 comments · Fixed by #334
Closed

README.md file enhancement. #333

anirudhsai20 opened this issue Feb 26, 2021 · 2 comments · Fixed by #334
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@anirudhsai20
Copy link
Contributor

Description of the problem

The README.md file does not have the list of all the open source programs in which this is a part of. It also does not include the list of research papers in which this is cited. It also does not have a display of all its contributors. It also features a lot of grammatical errors in the description.

Example of the problem

References/Other comments

The README.md file can be further enhanced by adding a list of Open source programs, its contributors, resesrch papers and correcting the grammatical errors.

@anirudhsai20
Copy link
Contributor Author

Hi! Please allow me to work on this issue under SWOC.

@czgdp1807
Copy link
Member

czgdp1807 commented Feb 27, 2021

The README.md file does not have the list of all the open source programs in which this is a part of.

It is not necessary to add a list of open source programs where we participated.

It also does not include the list of research papers in which this is cited.

I am not aware of any research paper where this project is cited. It would be better to do focus on citations once we go for our first release.

It also does not have a display of all its contributors.

Check the AUTHORS file. Contributors can add their names to this file if they want to be counted as author of this project.

It also features a lot of grammatical errors in the description.

Please feel free to correct them in your PR.

Hi! Please allow me to work on this issue under SWOC.

Sure.

@czgdp1807 czgdp1807 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 27, 2021
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants