Revamped content and layout of project docs (README, CONTRIBUTING, etc) #2770
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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
reviewed
Dec 19, 2024
docs/CONTRIBUTING.md
Outdated
| unit tests. Tests can either be traditional code based tests, or tests that pull in data files and compare inputs to outputs (see below). | ||
| * `package.json` - The [node](http://nodejs.org) metadata container file. | ||
| Modules imported in `index.ts` should be listed here under `dependencies`, | ||
| and modules used in `test.ts` or `bench.ts` should be listed under |
There was a problem hiding this comment.
I was going to comment on just these two instances, but there's a lot of usages of "module" in this file that are probably more canonically called "packages". Might be worth switching around.
There was a problem hiding this comment.
Updated to use consistent terminology.
|
|
||
| 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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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! 👏