diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/internals/code-of-conduct.rst | 2 | ||||
| -rw-r--r-- | doc/internals/contributing.rst | 12 | ||||
| -rw-r--r-- | doc/internals/organization.rst | 2 | ||||
| -rw-r--r-- | doc/internals/release-process.rst | 4 |
4 files changed, 15 insertions, 5 deletions
diff --git a/doc/internals/code-of-conduct.rst b/doc/internals/code-of-conduct.rst index 8e31ef0..c7e2e34 100644 --- a/doc/internals/code-of-conduct.rst +++ b/doc/internals/code-of-conduct.rst @@ -2,4 +2,4 @@ .. _code_of_conduct: -.. include:: ../../CODE_OF_CONDUCT +.. include:: ../../CODE_OF_CONDUCT.rst diff --git a/doc/internals/contributing.rst b/doc/internals/contributing.rst index 195f6a5..207374e 100644 --- a/doc/internals/contributing.rst +++ b/doc/internals/contributing.rst @@ -114,7 +114,7 @@ These are the basic steps needed to start developing on Sphinx. Write your code along with tests that shows that the bug was fixed or that the feature works as expected. -#. Add a bullet point to :file:`CHANGES` if the fix or feature is not trivial +#. Add a bullet point to :file:`CHANGES.rst` if the fix or feature is not trivial (small doc updates, typo fixes), then commit:: git commit -m '#42: Add useful new feature that does this.' @@ -142,7 +142,7 @@ Please follow these guidelines when writing code for Sphinx: * Try to use the same code style as used in the rest of the project. -* For non-trivial changes, please update the :file:`CHANGES` file. If your +* For non-trivial changes, please update the :file:`CHANGES.rst` file. If your changes alter existing behavior, please document this. * New features should be documented. Include examples and use cases where @@ -197,6 +197,14 @@ To run JavaScript tests, use ``npm``:: npm install npm run test +.. tip:: + + ``karma`` requires a Firefox binary to use as a test browser. + + For Unix-based systems, you can specify the path to the Firefox binary using:: + + FIREFOX_BIN="/Applications/Firefox.app/Contents/MacOS/firefox" npm test + New unit tests should be included in the ``tests`` directory where necessary: diff --git a/doc/internals/organization.rst b/doc/internals/organization.rst index 9dec923..8ca1446 100644 --- a/doc/internals/organization.rst +++ b/doc/internals/organization.rst @@ -24,7 +24,7 @@ The following are some general guidelines for core developers: in a good working state and that all tests pass before pushing your changes. * When committing code written by someone else, please attribute the original - author in the commit message and any relevant :file:`CHANGES` entry. + author in the commit message and any relevant :file:`CHANGES.rst` entry. Membership ~~~~~~~~~~ diff --git a/doc/internals/release-process.rst b/doc/internals/release-process.rst index 50648cd..5d14c44 100644 --- a/doc/internals/release-process.rst +++ b/doc/internals/release-process.rst @@ -117,9 +117,11 @@ Date Python 05 Apr 2024 3.10+ ----------- ------ 04 Apr 2025 3.11+ +----------- ------ +24 Apr 2026 3.12+ =========== ====== Release procedures ------------------ -The release procedures are listed in ``utils/release-checklist``. +The release procedures are listed in :file:`utils/release-checklist.rst`. |