diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 41b3577..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,128 +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/flask-marshmallow/issues?state=open - - -Contributing Code ------------------ - -In General -++++++++++ - -- `PEP 8`_, when sensible. -- Test ruthlessly. Write docs for new features. -- Even more important than Test-Driven Development--*Human-Driven Development*. - -.. _`PEP 8`: http://www.python.org/dev/peps/pep-0008/ - -In Particular -+++++++++++++ - - -Setting Up for Local Development -******************************** - -1. Fork flask-marshmallow_ on GitHub. - -:: - - $ git clone https://github.com/marshmallow-code/flask-marshmallow.git - $ cd flask-marshmallow - -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 -******************** - -flask-marshmallow 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 `Travis 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. - -Contributing Examples -********************* - -Have a usage example you'd like to share? Feel free to add it to the `examples `_ directory and send a pull request. - - -.. _Sphinx: http://sphinx.pocoo.org/ -.. _`reStructuredText`: https://docutils.sourceforge.io/rst.html -.. _flask-marshmallow: https://github.com/marshmallow-code/flask-marshmallow diff --git a/docs/index.rst b/docs/index.rst index 421ff95..8034549 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -253,6 +253,8 @@ Project Info license changelog + Contributing + Code of Conduct .. _marshmallow: http://marshmallow.readthedocs.io diff --git a/pyproject.toml b/pyproject.toml index 2ea8982..7a488b2 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 5e9ce7b..e50103c 100644 --- a/tox.ini +++ b/tox.ini @@ -34,7 +34,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