search

code-for-chapel-hill / NC-COVID-Support

Community support site, supporting COVID-19 business opening hours, Food Banks, School Meals, Farms and Social Services.
https://nccovidsupport.org
GNU General Public License v3.0
16 stars 39 forks source link

update readme with spelling errors & enhancements #220

Closed ronitsingh1405 closed 4 years ago

ronitsingh1405 commented 4 years ago

There were a few grammatical errors which I have corrected. I have also enhanced the file with a few capitalizations here and there to make it look professional.

readingdancer commented 4 years ago

Hi @ronitsingh1405

Thank you for submitting this PR, it's really appreciated that you have tried to help, however I won't be able to merge in this PR. Our Readme.md file has purposefully been written in a friendly conversational style and has been well accepted so far by others who have read it.

I'm afraid I disagree about the CAPITALIZATION ... I find it harder to read and the majority of projects I used as references for good Readme files did not use this.

We have also used this plugin when writing the markdown file to keep a uniform style to our writing that you might also find useful if you have not seen it before:

https://github.com/DavidAnson/vscode-markdownlint

Please don't let this put you off working on any of our outstanding issues, it would be great to have your help on the coding tickets.

Cheers,

Chris