From 0181a05ad9293f77592f29a7f88d78fbbd33aabd Mon Sep 17 00:00:00 2001 From: Steven Loria Date: Tue, 2 Jun 2026 18:26:23 -0400 Subject: [PATCH 1/2] Link to shared CoC and CONTRIBUTING.md --- CONTRIBUTING.rst | 117 ------------------------------------------ README.rst | 2 +- docs/contributing.rst | 1 - docs/index.rst | 3 +- pyproject.toml | 1 - tox.ini | 2 +- 6 files changed, 4 insertions(+), 122 deletions(-) delete mode 100644 CONTRIBUTING.rst delete mode 100644 docs/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 423d5849..00000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,117 +0,0 @@ -Contributing Guidelines -======================= - -Security Contact Information ----------------------------- - -To report a security vulnerability, please use the -`Tidelift security contact `_. -Tidelift will coordinate the fix and disclosure. - -Questions, Feature Requests, Bug Reports, and Feedback. . . ------------------------------------------------------------ - -. . .should all be reported on the `GitHub Issue Tracker`_ . - -.. _`GitHub Issue Tracker`: https://github.com/marshmallow-code/apispec/issues?state=open - -Contributing Code ------------------ - -Setting Up for Local Development -++++++++++++++++++++++++++++++++ - -1. Fork apispec_ on GitHub. - -:: - - $ git clone https://github.com/marshmallow-code/apispec.git - $ cd apispec - -2. Install `uv `_. - -3. Install development requirements. - -:: - - $ uv sync - -4. (Optional but recommended) Install the pre-commit hooks, which will format and lint your git staged files. - -:: - - $ uv run pre-commit install --allow-missing-config - - -Git Branch Structure -++++++++++++++++++++ - -apispec abides by the following branching model: - - -``dev`` - Current development branch. **New features should branch off here**. - -``X.Y-line`` - Maintenance branch for release ``X.Y``. **Bug fixes should be sent to the most recent release branch.** The maintainer will forward-port the fix to ``dev``. Note: exceptions may be made for bug fixes that introduce large code changes. - -**Always make a new branch for your work**, no matter how small. Also, **do not put unrelated changes in the same branch or pull request**. This makes it more difficult to merge your changes. - -Pull Requests -++++++++++++++ - -1. Create a new local branch. - -:: - - # 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 `_. - -:: - - $ 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: :: - - $ uv run pytest - -To run syntax checks: :: - - $ uv run tox -e lint - -(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): :: - - $ 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 the docs in "watch" mode: :: - - $ uv run tox -e docs-serve - -Changes in the `docs/` directory will automatically trigger a rebuild. - -.. _Sphinx: http://sphinx.pocoo.org/ -.. _`reStructuredText`: https://docutils.sourceforge.io/rst.html -.. _`apispec`: https://github.com/marshmallow-code/apispec diff --git a/README.rst b/README.rst index 5ccc4ec8..e128b255 100644 --- a/README.rst +++ b/README.rst @@ -280,7 +280,7 @@ Project Links - Docs: https://apispec.readthedocs.io/ - Changelog: https://apispec.readthedocs.io/en/latest/changelog.html -- Contributing Guidelines: https://apispec.readthedocs.io/en/latest/contributing.html +- Contributing Guidelines: https://github.com/marshmallow-code/.github/blob/main/CONTRIBUTING.md - PyPI: https://pypi.python.org/pypi/apispec - Issues: https://github.com/marshmallow-code/apispec/issues diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index e582053e..00000000 --- a/docs/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CONTRIBUTING.rst diff --git a/docs/index.rst b/docs/index.rst index 55c83b85..afa27ed9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -247,5 +247,6 @@ Project Info upgrading ecosystem authors - contributing + Contributing + Code of Conduct license diff --git a/pyproject.toml b/pyproject.toml index a876a495..17b7308c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,7 +61,6 @@ include = [ "docs/", "tests/", "CHANGELOG.rst", - "CONTRIBUTING.rst", "SECURITY.md", "tox.ini", ] diff --git a/tox.ini b/tox.ini index 3dcda800..aa945fd4 100644 --- a/tox.ini +++ b/tox.ini @@ -30,7 +30,7 @@ commands = sphinx-build docs/ docs/_build {posargs} deps = sphinx-autobuild extras = marshmallow 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 From 1ffc3fbef7dee83a89b202bc1c845c4b26479959 Mon Sep 17 00:00:00 2001 From: Steven Loria Date: Tue, 2 Jun 2026 18:31:54 -0400 Subject: [PATCH 2/2] address warning --- docs/upgrading.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/upgrading.rst b/docs/upgrading.rst index bb4e041c..bcf0e63e 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -16,7 +16,7 @@ location is ignored in field metadata have a single location. A ``Schema`` with fields from different locations must be split into multiple -``Schema``s. +``Schema`` classes. Upgrading to 3.0.0 ------------------