README.md Updates - Githubissues

rpauly18 commented 4 years ago

1) The description of how to work on the documentation makes sense, even the description of the featureBranch, but the instructions stop short of actually submitting a PR to MHKiT-Software/MHKiT. @ssolson I can take a stab at adding this description, unless you already assigned it to Sean.

2) Should we have a list of unresolved issues with the Docs in the README? Would it not be better to simply just have Issues on each? @kmruehl

ssolson commented 4 years ago

Hey, Rebecca please take a stab at it. I would love another viewpoint on the laid out procedure!

kmruehl commented 4 years ago

@rpauly18

I agree with the suggestion to include a PR step. I updated the README to include Step 6. Submit a PR, but didn't add much detail there
I agree that the unresolved issues with the Doc should be open as repository issues. I can create a few issues for them now.

I found a few minor things that need to be udpated:

[x] Step 5 has a few minor issues that need to be updated: a) it says to push to a feature branch on origin, and it should be pushed to your fork. b) a few typos
[x] remove unresolved issues section and opens repo issues
[x] There's a formatting issue with Step 1. 'Once cloned used the" should be a fourth bullet.

MHKiT-Software / MHKiT

README.md Updates #21