Skip to content

Commit

Permalink
Add in the readme what is looked for by the linter
Browse files Browse the repository at this point in the history
  • Loading branch information
David-Wobrock committed Jan 21, 2019
1 parent 1a9024e commit 4c5d128
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,19 @@ Examples
3YOURMIND is running the linter on every build getting pushed through CI.
Checkout the ``examples/`` folder to see how you could integrate the linter in your test suite.

Backward incompatible migrations
--------------------------------

The linter analyses your migrations and checks the SQL for:

- Added ``NOT NULL`` columns, which don't have a DEFAULT value
- Dropping columns
- Renaming columns
- Renaming tables
- Altering columns (which can be backward compatible and eventually ignored)

Those are the most important and frequent backward incompatible migrations. We are happy to add more if you have some.

Ignoring migrations
-------------------

Expand Down Expand Up @@ -97,6 +110,5 @@ License
*django-migration-linter* is released under the `Apache 2.0 License`_.


.. _`Bitbucket Pipelines`: https://bitbucket.org/product/features/pipelines
.. _`tox`: https://pypi.python.org/pypi/tox
.. _`Apache 2.0 License`: https://github.com/3YOURMIND/django-migration-linter/blob/master/LICENSE

0 comments on commit 4c5d128

Please sign in to comment.