Fix README and CONTRIBUTING
parent
fc253665dd
commit
e30af0287f
|
|
@ -103,16 +103,17 @@ Maintainer's notes
|
|||
Release checklist
|
||||
=================
|
||||
|
||||
* update ``docs/changelog.rst`` with changes since the latest tag
|
||||
* commit & tag the release
|
||||
* update ``docs/changelog.rst`` with changes since the last tagged version
|
||||
* commit & tag the release - ``git tag x.x.x -m "Release version x.x.x"``
|
||||
* push using ``git push --follow-tags``
|
||||
* verify that `Travis`_ has built the tag and succesfully published the release to PyPI
|
||||
* verify that `Travis`_ has built the tag and succesfully published the release to `PyPI`_
|
||||
* publish release notes `on GitHub`_
|
||||
* start the `ReadTheDocs build`_ if it has not already started
|
||||
* deploy the live demo `on Heroku`_
|
||||
|
||||
|
||||
.. _Travis: https://travis-ci.org/axnsan12/drf-yasg/builds
|
||||
.. _PyPI: https://pypi.org/project/drf-yasg/
|
||||
.. _on GitHub: https://github.com/axnsan12/drf-yasg/releases
|
||||
.. _ReadTheDocs build: https://readthedocs.org/projects/drf-yasg/builds/
|
||||
.. _on Heroku: https://dashboard.heroku.com/pipelines/412d1cae-6a95-4f5e-810b-94869133f36a
|
||||
|
|
|
|||
|
|
@ -42,10 +42,8 @@ Features
|
|||
- generated Swagger schema can be automatically validated by
|
||||
`swagger-spec-validator <https://github.com/Yelp/swagger_spec_validator>`_ or
|
||||
`flex <https://github.com/pipermerriam/flex>`_
|
||||
- supports Django REST Framework API versioning
|
||||
|
||||
+ ``URLPathVersioning`` and ``NamespaceVersioning`` are supported
|
||||
+ ``HostnameVersioning``, ``AcceptHeaderVersioning`` and ``QueryParameterVersioning`` are not currently supported
|
||||
- supports Django REST Framework API versioning with ``URLPathVersioning`` and ``NamespaceVersioning``; other DRF
|
||||
or custom versioning schemes are not currently supported
|
||||
|
||||
.. figure:: https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/redoc-nested-response.png
|
||||
:width: 100%
|
||||
|
|
|
|||
Loading…
Reference in New Issue