Edit and proofread CONTRIBUTING.md

[jtoar]

This is for reference for #434.

This PR includes changes that I think would be immediate improvements on the document as it stands. It adds a short welcome message, and edits/proofreads CONTRIBUTING.md generally, but shies away from making any major organizational changes.

[thedavidprice]

This is good progress. Let's see if there are any learnings/updates to apply from the thread in #429

Also, I'd be game to try the Google Docs to PR workflow on this one. I have comments I want to add here, but never feels easy as it could be using code review tools for Markdown. Wanna give the Docs process I described in the Forum DM a shot?

[peterp]

This is so great, thank you @jtoar <3!

[jtoar]

@thedavidprice Let's do it--I'll close this out and open an issue instead? And @peterp of course!

[jtoar]

@thedavidprice Opened #439.

[thedavidprice]

Consolidating notes:

• keep this PR open
• edits to take place in Improvements to CONTRIBUTING.md: General proofreading #439 and Google Doc
• will port edits here for merging

[jtoar]

Going to request a final review from @thedavidprice (sorry it took much so long). All the commands work (on my machine), as written, in the order they're written.

I applied most of the edits in the google docs. A few things that are different:

• Table of content section names are the same as the section. So Local Package Registry Emulation is in the table of contents instead of Emulate NPM.
• The actual rwt command is copy:watch, so I renamed the section Copy and Watch (instead of Watch and Copy)
• I don't have instructions for creating an environment variable on Windows so the section's just not there.

Going to reference an issue from the @redwoodjs/redwoodjs.com repo: redwoodjs/redwoodjs.com#15. The code blocks for explaining how ./tasks/publish-local works might confuse cursory readers. I.e., this isn't actually meant to be run:

npm unpublish --tag dev --registry http://localhost:4873/ --force
npm publish --tag dev --registry http://localhost:4873/ --force

As of now I've just left it there. Definitely something for the future though.

[peterp]

The code blocks for explaining how ./tasks/publish-local works might confuse cursory readers.

That's a very good point!

[thedavidprice]

@jtoar Apologies but I'm in a time crunch and made a mess of the workflow to commit back to your original branch. Could you see my edits here in this repo? https://github.com/thedavidprice/contributing/blob/master/CONTRIBUTING.md

Pull in all you can/want to your branch, and then we'll get this merged before a release. Thanks again!

[jtoar]

@thedavidprice Double checking now but think I made every change in the doc you linked here. So should be ready to merge!

[thedavidprice]

@jtoar You're a champion. And apologies again for making the workflow a pain. We'll figure this out.

Two quick changes for you to accept (one a redundant sentence and the other a new line).

🚀

[jtoar]

@thedavidprice applied! No worries, I'm learning a lot just from the back-and-forths; we'll have six more chances coming up in the six READMEs for #461 😅

[thedavidprice]

Indeed!

Well, just know your work isn’t taken for granted. We’ll get this smoothed out going forward.

[jtoar]

👍 No worries at all you and the team are a pleasure to work with!