Skip to content

Commit a8cbea3

Browse files
smallsaucepanmfedderlytwelch
authored
Revamped content and layout of project docs (README, CONTRIBUTING, etc) (#2770)
* Moved "optional" project documentation files to docs/ subdir to minimise clutter in project root. * Verbatim copy of Contributor Covenant v2.1. Updated code of conduct contact details, removing anyone who don't list obvious contact details (@lyzidiamond and @tcql). * Split publishing topic out into a separate document. Only a small subset of contributors will ever publish so better to have CONTRIBUTING focus on coding and PR related activities. * Updated issue and PR templates to read a bit better, ask for more meaningful details. * Updating open collective stats, project goals for coming year. * Split readme into a few pieces. 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! Co-authored-by: mfedderly <[email protected]> Co-authored-by: Tim Welch <[email protected]> --------- Co-authored-by: mfedderly <[email protected]> Co-authored-by: Tim Welch <[email protected]>
1 parent d1a2c58 commit a8cbea3

13 files changed

+522
-566
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
Please provide the following when reporting an issue:
22

3-
- [ ] The version of Turf you are using, and any other relevant versions.
4-
- [ ] GeoJSON data as a [gist file](https://gist.github.com/) or [geojson.io](http://geojson.io/) (filename extension must be `.geojson`).
5-
- [ ] Snippet of source code or for complex examples use [jsfiddle](https://jsfiddle.net/).
6-
- [ ] Verify this issue hasn't already been reported, or resolved in the latest alpha pre-release.
3+
- [ ] Description of the problem, and how it differs from what you expected.
4+
- [ ] Version of Turf you are using, and of any other relevant software.
5+
- [ ] GeoJSON data as a [gist file](https://gist.github.com/) or [geojson.io](https://geojson.io/) (filename extension must be `.geojson`). Simple reproducible examples are preferrable.
6+
- [ ] Snippet of source code for complex examples using [jsfiddle](https://jsfiddle.net/).
7+
- [ ] Confirmation this issue hasn't already been reported, or is resolved and just hasn't been released yet.
78

89
<!-- Love turf? Please consider supporting our collective:
910
👉 https://opencollective.com/turf/donate -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
Please fill in this template. Use a meaningful title for the pull request. Include the name of the package modified.
1+
Please provide the following when creating a PR:
22

3-
- [ ] Is this a bug fix, new functionality, or a breaking change?
4-
- [ ] Have read and followed the steps for [preparing a pull request](https://github.com/Turfjs/turf/blob/master/CONTRIBUTING.md#preparing-a-pull-request).
5-
6-
Submitting a new TurfJS Module.
7-
8-
- [ ] Overview description of proposed module.
9-
- [ ] Include JSDocs with a basic example.
10-
- [ ] Execute `./scripts/generate-readmes` to create `README.md`.
11-
- [ ] Add yourself to **contributors** in `package.json` using "Full Name <@GitHub Username>".
3+
- [ ] Meaningful title, including the name of the package being modified.
4+
- [ ] Summary of the changes.
5+
- [ ] Heads up if this is a breaking change.
6+
- [ ] Any issues this [resolves](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests).
7+
- [ ] Inclusion of your details in the `contributors` field of `package.json` - you've earned it! 👏
8+
- [ ] Confirmation you've read the steps for [preparing a pull request](https://github.com/Turfjs/turf/blob/master/docs/CONTRIBUTING.md#preparing-a-pull-request).

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

0 commit comments

Comments
 (0)