mirror/django-mailbox
1
0
Fork 1
mirror of https://github.com/coddingtonbear/django-mailbox.git synced 2026-07-10 06:48:19 +02:00
Code Activity

Fix typo in development procedure

Browse source
This commit is contained in:
Adam Dobrawy 2018-01-13 02:41:54 +01:00
parent 9f492b2501
commit f2442b3ec9
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/topics/development.rst
View file

@ -17,7 +17,7 @@ How do I get involved?
It's simple! If you want to fix a bug, extend documentation or whatever you It's simple! If you want to fix a bug, extend documentation or whatever you
think is appropriate for the project and involves changes, just fork the think is appropriate for the project and involves changes, just fork the
project at github (https://github.com/coddingtonbear/django-mailbox), create a project on github (https://github.com/coddingtonbear/django-mailbox), create a
separate branch, hack on it, publish changes at your fork and create a pull separate branch, hack on it, publish changes at your fork and create a pull
request. request.
@ -35,25 +35,25 @@ How to do a new release?
To enroll a new release you should perform the following task: To enroll a new release you should perform the following task:
* Ensure file ``CHANGELOG.rst`` reflects all important changes. * Ensure the file ``CHANGELOG.rst`` reflects all important changes.
* Ensure file ``CHANGELOG.rst`` includes a new version identifier and current release date. * Ensure the file ``CHANGELOG.rst`` includes a new version identifier and current release date.
* Execute ``bumpversion patch`` (or accordinly - see `Semantic Versioning 2.0 <http://semver.org/>`_ ) to reflects changes in codebase. * Execute ``bumpversion patch`` (or accordingly - see `Semantic Versioning 2.0 <http://semver.org/>`_ ) to reflect changes in codebase.
* Commit changes of codebase, e.g. ``git commit -m "Release 1.4.8" -a``. * Commit changes to the codebase, e.g. ``git commit -m "Release 1.4.8" -a``.
* Tag a new release, e.g. ``git tag "1.4.8"``. * Tag a new release, e.g. ``git tag "1.4.8"``.
* Push new tag to repo - ``git push origin --tags``. * Push new tag to repo - ``git push origin --tags``.
* Push a new release to PyPI - ``python setup.py sdist bdist_wheel upload``. * Push a new release to PyPI - ``python setup.py sdist bdist_wheel upload``.
How to add support for new Django version? How to add support for a new Django version?
------------------------------------------ ------------------------------------------
Changes are only necessary for new minor or major Django versions. Changes are only necessary for new minor or major Django versions.
To add support for new version perform the following task: To add support for a new version perform the following task:
* Ensure ``tox.ini`` file reflects support for new Django release. * Ensure that ``tox.ini`` file reflects support for new Django release.
* Verify in tox that the code is executed correctly on all versions of the Python interpreter. * Verify in tox that the code is executed correctly on all versions of the Python interpreter.
* Ensure ``.travis.yml`` file reflects support for new Django release. Note the excluded versions of the Python interpreter. * Ensure that ``.travis.yml`` file reflects support for new Django release. Note the excluded versions of the Python interpreter.
* Verify by pushing changes on a separate branch to see if the changes in TravisCI are correct. * Verify by pushing changes on a separate branch to see if the changes in TravisCI are correct.
* Proceed to the standard procedure of the new package release (see `How to do a new release?`_ ). * Proceed to the standard procedure for a new package release (see `How to do a new release?`_ ).
A `spreadsheet is available <https://docs.google.com/spreadsheets/d/1YsVPDeOAgf_c_7XOXh6SZUO2ebMNoFXysxfj4r1tFiM/edit?usp=sharing>`_ that can assist this process. A `spreadsheet with generator is available <https://docs.google.com/spreadsheets/d/1YsVPDeOAgf_c_7XOXh6SZUO2ebMNoFXysxfj4r1tFiM/edit?usp=sharing>`_ that can assist this process.