diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 5017a43d..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1 +0,0 @@ -For the code of conduct, see https://marshmallow.readthedocs.io/en/dev/code_of_conduct.html diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index bd35c0b5..00000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,136 +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/webargs/issues?state=open - - -Contributing Code ------------------ - -Integration with a Another Web Framework… -+++++++++++++++++++++++++++++++++++++++++ - -…should be released as a separate package. - -**Pull requests adding support for another framework will not be -accepted**. In order to keep webargs small and easy to maintain, we are -not currently adding support for more frameworks. Instead, release your -framework integration as a separate package and add it to the -`Ecosystem `_ page in -the `GitHub wiki `_ . - -Setting Up for Local Development -++++++++++++++++++++++++++++++++ - -1. Fork webargs_ on GitHub. - -:: - - $ git clone https://github.com/marshmallow-code/webargs.git - $ cd webargs - -2. Install development requirements. **It is highly recommended that you use a virtualenv.** - Use the following command to install an editable version of - webargs along with its development requirements. - -:: - - # After activating your virtualenv - $ pip install -e ".[dev]" - -3. (Optional, but recommended) Install the pre-commit hooks, which will format and lint your git staged files. - -:: - - # The pre-commit CLI was installed above - $ pre-commit install - -Git Branch Structure -++++++++++++++++++++ - -Webargs 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: :: - - $ pytest - -To run syntax checks: :: - - $ tox -e lint - -(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): :: - - $ 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: :: - - $ 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 -.. _webargs: https://github.com/marshmallow-code/webargs diff --git a/README.rst b/README.rst index c2a1fb20..8f00070d 100644 --- a/README.rst +++ b/README.rst @@ -98,7 +98,7 @@ Project Links - Docs: https://webargs.readthedocs.io/ - Changelog: https://webargs.readthedocs.io/en/latest/changelog.html -- Contributing Guidelines: https://webargs.readthedocs.io/en/latest/contributing.html +- Contributing Guidelines: https://github.com/marshmallow-code/.github/blob/main/CONTRIBUTING.md - PyPI: https://pypi.python.org/pypi/webargs - Issues: https://github.com/marshmallow-code/webargs/issues - Ecosystem / related packages: https://github.com/marshmallow-code/webargs/wiki/Ecosystem 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 1ea315d7..7633e1cf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -120,4 +120,5 @@ Project Info changelog upgrading authors - contributing + Contributing + Code of Conduct diff --git a/pyproject.toml b/pyproject.toml index 71163496..55562750 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -106,7 +106,6 @@ include = [ "docs/", "tests/", "CHANGELOG.rst", - "CONTRIBUTING.rst", "SECURITY.md", "NOTICE", "tox.ini", diff --git a/tox.ini b/tox.ini index b43521aa..7f2ab09a 100644 --- a/tox.ini +++ b/tox.ini @@ -43,7 +43,7 @@ commands = sphinx-build docs/ {posargs:docs/_build} [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