Revamped content and layout of project docs (README, CONTRIBUTING, etc) #2770
Conversation
…mise clutter in project root.
@tcql as they don't currently list obvious contact details.
…set of contributors will ever publish so better to have CONTRIBUTING focus on coding and PR related activities.
…uide. Cut a lot of cut and paste commands (hard to guarantee currency). Removed REGEN references - think it's use should be discouraged, though probably differing opinions on that one!
|
It is worth explicitly stating that this changes the code of conduct from Contributor Covenant 1.4 to 2.1. I don't have a problem with this change, but it feels important to state explicitly here. |
mfedderly
left a comment
mfedderly
left a comment
There was a problem hiding this comment.
This looks like a great refresh on the docs, I have a bunch of little nits.
Happy to approve but also happy to give others time to review as well.
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported to the community leaders responsible for enforcement at | ||
| [@morganherlocker](https://github.com/morganherlocker) or [@tmcw](https://github.com/tmcw). |
There was a problem hiding this comment.
It looks like we maybe removed a few people here, is anyone interested in being added?
Fixed a couple of spelling errors. Co-authored-by: mfedderly <[email protected]>
twelch
left a comment
twelch
left a comment
There was a problem hiding this comment.
I generally approve of these changes. See my comment about potentially dropping the GETTING_STARTED in this repo and linking to the versioned one on the doc website.
Co-authored-by: Tim Welch <[email protected]>
…stead of a duplicated file in docs/.
|
Thanks @mfedderly and @twelch. Incorporated all your suggestions. Will merge. |
3 participants
Felt like our project docs like README, CONTRIBUTING, etc were getting a bit messy. Have changed the layout and revised the content of many of them. Moved all but the publish to NPM non-negotiables (README, LICENSE and CHANGELOG) to the docs/ subdirectory.
As an example, split parts of README into GETTING_STARTED, and parts of CONTRIBUTING into PUBLISHING. Trimmed quite a bit of low level "type this command then this command" kind of thing.
Logic being some of these sections most contributors won't ever need to know, so better to keep what they will need as navigable as possible. And the step by step instruction sections are difficult to keep up to date or guarantee they'll work for everyone.
Updated the code of conduct from Contributor Covenant 1.4 to 2.1. Left the wording as is e.g. didn't bother customising from "community" to "project" or "member" to "maintainer".
Also revamped issue and PR templates to ask questions I felt when doing my own PRs would be more meaningful to answer.
Possibly easier to browse the PR branch than look at the MD diffs below - https://github.com/smallsaucepan/turf/tree/proj-doc-updates
Please take a look. Might be going too far for some. If so, add a comment and maybe we can add some things back in.
Please provide the following when creating a PR:
contributorsfield ofpackage.json- you've earned it! 👏