fix #607 - no longer need to manually include for toctree

testcontainers · Jul 2, 2024 · 91945be · 91945be
1 parent e93bc29
commit 91945be
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE/new_container.md b/.github/PULL_REQUEST_TEMPLATE/new_container.md
@@ -28,7 +28,6 @@ It helps reduce unnecessary work for you and the maintainers!
   - it is declared under `tool.poetry.extras` with the same name as your module name,
     we still prefer adding _NO EXTRA DEPENDENCIES_, meaning `mymodule = []` is the preferred addition
     (see the notes at the bottom)
-- [ ] The `INDEX.rst` at the project root includes your module under the `.. toctree` directive
 - [ ] Your branch is up to date (or we'll use GH's "update branch" function through the UI)
 
 # Preferred implementation

diff --git a/index.rst b/index.rst
@@ -139,4 +139,7 @@ Testcontainers is a collection of `implicit namespace packages <https://peps.pyt
 Contributing a New Feature
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-You want to contribute a new feature or container? Great! You can do that in six steps as outlined `here <https://github.com/testcontainers/testcontainers-python/blob/main/.github/PULL_REQUEST_TEMPLATE/new_container.md>__`.
+You want to contribute a new feature or container? Great!
+- We recommend you first `open an issue <https://github.com/testcontainers/testcontainers-python/issues/new/choose>`_
+- Then follow the suggestions from the team
+- We also have a Pull Request `template <https://github.com/testcontainers/testcontainers-python/blob/main/.github/PULL_REQUEST_TEMPLATE/new_container.md>`_ for new containers!