Skip to content

docs: fix typos in CONTRIBUTING.md files #1030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
TejasAmle wants to merge 1 commit into from
Closed

docs: fix typos in CONTRIBUTING.md files #1030

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ We have an [issue template](./ISSUE_TEMPLATE/new-container.md) for adding new co
Once you've talked to the maintainers (we do our best to reply!) then you can proceed with contributing the new container.

> [!WARNING]
> PLease raise an issue before you try to contribute a new container! It helps maintainers understand your use-case and motivation.
> This way we can keep pull requests foruced on the "how", not the "why"! :pray:
> Please raise an issue before you try to contribute a new container! It helps maintainers understand your use-case and motivation.
> This way we can keep pull requests focused on the "how", not the "why"! :pray:
> It also gives maintainers a chance to give you last-minute guidance on caveats or expectations, particularly with
> new extra dependencies and how to manage them.

Expand Down
8 changes: 4 additions & 4 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ Once you've talked to the maintainers (we do our best to reply!) then you can pr

!!!WARNING

Please raise an issue before you try to contribute a new container! It helps maintainersunderstand your use-case and motivation.
Please raise an issue before you try to contribute a new container! It helps maintainers understand your use-case and motivation.
This way we can keep pull requests forced on the "how", not the "why"! :pray:
It also gives maintainers a chance to give you last-minute guidance on caveats orexpectations, particularly with
It also gives maintainers a chance to give you last-minute guidance on caveats or expectations, particularly with
new extra dependencies and how to manage them.

### Module documentation

Leave examples for others with your mew module such as `modules/<new_module>/basic_example.py`. You can create as many examples as you want.
Leave examples for others with your new module such as `modules/<new_module>/basic_example.py`. You can create as many examples as you want.

Create a new `docs/modules/<new_module>.md` describing the basic use of the new container. There is a [starter template provided here](https://raw.githubusercontent.com/testcontainers/testcontainers-python/blob/main/docs/modules/template.md){:target="\_blank"}.

Expand Down Expand Up @@ -81,7 +81,7 @@ This takes care of:

## Documentation contributions

The _Testcontainers for Go_ documentation is a static site built with [MkDocs](https://www.mkdocs.org/){:target="\_blank"}.
The _Testcontainers for Python_ documentation is a static site built with [MkDocs](https://www.mkdocs.org/){:target="\_blank"}.
We use the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/){:target="\_blank"} theme, which offers a number of useful extensions to MkDocs.

We publish our documentation using Netlify.
Expand Down