Update README to be more complete and clear

chicagomaroon / data-visualizations

This repository contains and hosts interactive visuals used in The Chicago Maroon publication.

https://chicagomaroon.com/

4 stars 2 forks source link

Update README to be more complete and clear #89

Closed air-kyi closed 2 months ago

air-kyi commented 2 months ago

What does this PR do?

Edit docs after read-through

Make links accessible to screenreaders
Add flexibility to instructions for various operating systems (Windows) and terminals (git bash)
Fix typos

How was the functionality tested and verified?

michplunkett commented 2 months ago

Couple of things:

Could you write the title of the PR in the present imperative tense? Examples of that tense are: "Fix issue in the dispatcher where…", "Improve our handling of…", etc."
Could you write the PR description using the format that was already there? Leave the tested and verifying part tho.
```
## What does this PR do?
[your description goes here]
```

michplunkett commented 2 months ago

You should be submitting pull requests into main, not any other branch. I am also a little unsure as to why there is a README_edit and CONTRIBv2.

air-kyi commented 2 months ago

Hi Michael, first of all: Thanks for bringing me onto the Maroon, things are officially getting going as you can see! (I am Karen by the way.) You can also see that things are a work in progress...This branch is a draft-mode update to the docs written by Austin that I am testing out and giving feedback to. I'm also not sure why there's several versions but assuming it will be cleaned up before school year starts. And thanks for reviewing this PR as an alumnus, lol, lead devs are in the process of fixing the default tagged reviewers.

air-kyi commented 2 months ago

Comments addressed btw