diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index ca9e2bf..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,102 +0,0 @@ -Contributing guidelines -======================= - -Questions, feature requests, bug reports, and feedback. . . ------------------------------------------------------------ - -…should all be reported on the `Github Issue Tracker`_ . - -.. _`Github Issue Tracker`: https://github.com/marshmallow-code/marshmallow-sqlalchemy/issues?state=open - -Setting up for local development --------------------------------- - -1. Fork marshmallow-sqlalchemy_ on Github. - -.. code-block:: shell-session - - $ git clone https://github.com/marshmallow-code/marshmallow-sqlalchemy.git - $ cd marshmallow-sqlalchemy - -2. Install `uv `_. - -3. Install development requirements. - -.. code-block:: shell-session - - $ uv sync - -4. (Optional but recommended) Install the pre-commit hooks, which will format and lint your git staged files. - -.. code-block:: shell-session - - $ uv run pre-commit install --allow-missing-config - -Pull requests --------------- - -1. Create a new local branch. - -.. code-block:: shell-session - - # For a new feature - $ git checkout -b name-of-feature dev - - # For a bugfix - $ git checkout -b fix-something 1.2-line - -2. Commit your changes. Write `good commit messages `_. - -.. code-block:: shell-session - - $ git commit -m "Detailed commit message" - $ git push origin name-of-feature - -3. Before submitting a pull request, check the following: - -- If the pull request adds functionality, it is tested and the docs are updated. -- You've added yourself to ``AUTHORS.rst``. - -4. Submit a pull request to ``marshmallow-code:dev`` or the appropriate maintenance branch. - The `CI `_ build - must be passing before your pull request is merged. - -Running tests -------------- - -To run all tests: - -.. code-block:: shell-session - - $ uv run pytest - -To run formatting and syntax checks: - -.. code-block:: shell-session - - $ uv run tox -e lint - -(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): - -.. code-block:: shell-session - - $ uv run tox - -Documentation -------------- - -Contributions to the documentation are welcome. Documentation is written in `reStructuredText`_ (rST). A quick rST reference can be found `here `_. Builds are powered by Sphinx_. - -To build and serve the docs in "watch" mode: - -.. code-block:: shell-session - - $ uv run tox -e docs-serve - -Changes to documentation will automatically trigger a rebuild. - - -.. _Sphinx: https://www.sphinx-doc.org/ -.. _`reStructuredText`: https://docutils.sourceforge.io/rst.html - -.. _`marshmallow-sqlalchemy`: https://github.com/marshmallow-code/marshmallow-sqlalchemy diff --git a/README.rst b/README.rst index 760406d..ea48647 100644 --- a/README.rst +++ b/README.rst @@ -147,7 +147,7 @@ Project links - Docs: https://marshmallow-sqlalchemy.readthedocs.io/ - Changelog: https://marshmallow-sqlalchemy.readthedocs.io/en/latest/changelog.html -- Contributing Guidelines: https://marshmallow-sqlalchemy.readthedocs.io/en/latest/contributing.html +- Contributing Guidelines: https://github.com/marshmallow-code/.github/blob/main/CONTRIBUTING.md - PyPI: https://pypi.python.org/pypi/marshmallow-sqlalchemy - Issues: https://github.com/marshmallow-code/marshmallow-sqlalchemy/issues diff --git a/docs/conf.py b/docs/conf.py index e196b32..41314db 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,6 @@ extensions = [ "sphinx.ext.autodoc", - "sphinx.ext.autodoc.typehints", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "sphinx_copybutton", diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index e582053..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CONTRIBUTING.rst diff --git a/docs/index.rst b/docs/index.rst index b907319..228c271 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -135,7 +135,8 @@ Project info :maxdepth: 1 changelog - contributing + Contributing + Code of Conduct authors license diff --git a/pyproject.toml b/pyproject.toml index 6d029f1..a45bf3d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,7 +43,7 @@ requires = ["flit_core<4"] build-backend = "flit_core.buildapi" [tool.flit.sdist] -include = ["docs/", "tests/", "CHANGELOG.rst", "CONTRIBUTING.rst", "tox.ini"] +include = ["docs/", "tests/", "CHANGELOG.rst", "tox.ini"] exclude = ["docs/_build/"] [tool.ruff] diff --git a/tox.ini b/tox.ini index c5325bd..f04ac7e 100644 --- a/tox.ini +++ b/tox.ini @@ -35,7 +35,7 @@ commands = sphinx-build docs/ docs/_build {posargs} [testenv:docs-serve] deps = sphinx-autobuild dependency_groups = docs -commands = sphinx-autobuild --port=0 --open-browser --delay=2 docs/ docs/_build {posargs} --watch src --watch CONTRIBUTING.rst --watch README.rst +commands = sphinx-autobuild --port=0 --open-browser --delay=2 docs/ docs/_build {posargs} --watch src --watch README.rst [testenv:readme-serve] deps = restview