Fill our contributor docs

Author: AWhetter

README.rst

@@ -128,9 +128,9 @@ Tests are executed through `tox <https://tox.readthedocs.io/en/latest/>`_.
 Code Style
 ~~~~~~~~~~
 
-Code is formatted using `black <https://github.com/python/black>`_.
+Code is formatted using `ruff <https://github.com/python/black>`_.
 
-You can check your formatting using black's check mode:
+You can check your formatting using ruff's check mode:
 
 .. code-block:: bash
 
@@ -140,7 +140,7 @@ You can also get black to format your changes for you:
 
 .. code-block:: bash
 
-    tox -e format -- src/ tests/
+    .tox/format/bin/ruff src/ tests
 
 
 Release Notes

doc/source/contributor.rst

@@ -2,12 +2,57 @@
 Contributor Guide
 *****************
 
-.. todo::
+Making a Change
+===============
+
+Tests are executed through `tox <https://tox.readthedocs.io/en/latest/>`_.
+
+.. code-block:: bash
+
+    tox
+
+
+Code is formatted using `ruff <https://github.com/python/black>`_.
+
+.. code-block:: bash
+
+    tox -e autoformat
+
+
+When making a pull request you will need to create a news fragment to document your change.
+Release notes are managed through `towncrier <https://towncrier.readthedocs.io/en/stable/index.html>`_.
+
+.. code-block:: bash
+
+    tox -e release_notes -- create --help
 
-    * Making a change
-      * Tests
-      * Formatting
-      * Release notes
 
 Release Process
-===============
+===============
+
+This page documents the steps to be taken to release a new version of Sphinx AutoAPI.
+
+Pre-Checks
+----------
+
+1. Check that the dependencies of the package are correct.
+2. Clean the ``.tox`` directory and run the tests.
+3. Commit and push any changes needed to make the tests pass.
+4. Check that the tests passed on github.
+
+Preparation
+-----------
+
+1. Update the version numbers in ``autoapi/__init__.py``.
+2. Run ``tox -e release_notes -- build``
+3. Commit and push the changes.
+4. Check that the tests passed on github.
+
+Release
+-------
+
+1. Create a new release in github that tags the commit
+   and uses the built release notes as the description.
+
+The tag created by the release will trigger the github actions to
+build and upload the package to PyPI.

tests/conftest.py

@@ -16,4 +16,4 @@ def pytest_collection_modifyitems(items):
         }
         for item in items:
             if item.nodeid in to_skip:
-                item.addmarker(pytest.mark.xfail)
+                item.add_marker(pytest.mark.xfail)

tox.ini

@@ -31,6 +31,13 @@ dependency_groups =
 commands =
     ruff format --check --diff
 
+[testenv:autoformat]
+runner = uv-venv-lock-runner
+dependency_groups =
+    format
+commands =
+    ruff format
+
 [testenv:lint]
 runner = uv-venv-lock-runner
 dependency_groups =