Skip to content

Commit efe8faf

Browse files
subfuzioniennae
authored andcommitted
docs: update contributing guide
1 parent 6e61e3d commit efe8faf

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,22 @@ All samples must have tests. We use `mocha` as testing framework. The
4848
executes the `mocha` tests via `npm test`
4949
([example](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/batch/package.json#L13)).
5050

51+
### Third party libraries
52+
53+
Contributors are encouraged to use vanilla Node.js as much as pragmatically
54+
possible to standardize writing, reviewing, and maintaining samples and their
55+
tests, ideally reducing dependencies on third party libraries.
56+
57+
For tests, using the standard
58+
library [assert](https://nodejs.org/docs/latest-v18.x/api/assert.html) is
59+
preferred.
60+
61+
If you want to use a third party package, help us to understand if you have
62+
requirements not fulfilled by core libraries in the description of your pull
63+
request.
64+
65+
### CI testing
66+
5167
For new samples, a GitHub Actions workflow should be created to run your tests
5268
on the CI system:
5369

0 commit comments

Comments
 (0)