Skip to content

Commit

Permalink
docs: update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
subfuzion authored and iennae committed Oct 5, 2024
1 parent 6e61e3d commit efe8faf
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,22 @@ All samples must have tests. We use `mocha` as testing framework. The
executes the `mocha` tests via `npm test`
([example](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/main/batch/package.json#L13)).

### Third party libraries

Contributors are encouraged to use vanilla Node.js as much as pragmatically
possible to standardize writing, reviewing, and maintaining samples and their
tests, ideally reducing dependencies on third party libraries.

For tests, using the standard
library [assert](https://nodejs.org/docs/latest-v18.x/api/assert.html) is
preferred.

If you want to use a third party package, help us to understand if you have
requirements not fulfilled by core libraries in the description of your pull
request.

### CI testing

For new samples, a GitHub Actions workflow should be created to run your tests
on the CI system:

Expand Down

0 comments on commit efe8faf

Please sign in to comment.