# Contributing

[Create an issue](https://github.com/testcontainers/testcontainers-node/issues) if you find any bugs.

[Create a pull request](https://github.com/testcontainers/testcontainers-node/pulls) if you wish to fix an issue or provide an enhancement. Please be sure to:
* Discuss with the authors via an issue or discussion prior to doing anything big.
* Follow the style, structure and naming conventions of the rest of the project.
* Make commits atomic and easy to merge.
* Run the Git hooks when making commits to ensure the code is linted and correctly formatted.
* Verify all tests are passing with `npm test`.

## Documentation

The documentation is a static site built with [MkDocs](https://www.mkdocs.org/) and the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme. In addition, we use a [custom plugin](https://github.com/rnorth/mkdocs-codeinclude-plugin) for inclusion of code snippets. We publish our documentation using Netlify.

### Updating the docs

To update the docs for your new module, you'll have to:
 - add a markdown file for your module in the docs/modules/ directory.
 - add a reference to your new markdown file in the mkdocs.yml file.

### Previewing rendered content

#### Using Docker

```shell
npm run docs:serve
```

Then access the docs at [http://localhost:8000](http://localhost:8000).

#### Using Python

* Ensure that you have Python 3.11.0 or higher.
* Set up a virtualenv and run `pip install -r requirements.txt` in the `testcontainers-node` root directory.
* Once Python dependencies have been installed, run `mkdocs serve` to start a local auto-updating MkDocs server.

#### PR preview deployments

Documentation for pull requests will automatically be published by Netlify as "deploy previews". These deployment previews can be accessed via the `deploy/netlify` check that appears for each pull request.