You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+4-14Lines changed: 4 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,7 +124,7 @@ JSDoc comments are found in the top-level index file for each package (for examp
124
124
125
125
We have lots of tooling dedicated to ensuring consistent code. We use [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/), and [ESLint](https://eslint.org/) to help us deliver quality code. These are checked by the build system and should be enforced at commit time by [Husky](https://typicode.github.io/husky/#/).
126
126
127
-
Most packages are written in TypeScript, while a few plain Javascript still linger. You can generally use modern Javascript when modifying Turf itself as all exported code is transpiled to (currently es2017).
127
+
Packages are written in TypeScript. You can generally use modern TypeScript when modifying Turf itself as all exported code is transpiled to a more compatible subset (currently es2017).
128
128
129
129
Code for consumption by browsers is transpiled by Babel as described in the README.
130
130
@@ -140,25 +140,13 @@ Should you want to generate new README files manually, use `pnpm run docs`:
@@ -171,6 +159,8 @@ Building Docs: @turf/boolean-clockwise
171
159
....
172
160
```
173
161
162
+
Note: This should be automatically executed with a pre-commit hook when necessary
163
+
174
164
### Public website
175
165
176
166
The [turfjs.org](https://turfjs.org/) website is managed in a [separate repo](https://github.com/Turfjs/turf-www) with its own [contributing guide](https://github.com/Turfjs/turf-www/blob/master/CONTRIBUTING.md).
0 commit comments