From 3c4b5b165cfe82c314976a76c044759bcaf1e22e Mon Sep 17 00:00:00 2001 From: Clinton Blackburn Date: Wed, 26 Jun 2019 23:31:43 -0700 Subject: [PATCH] Added contributor doc Added Jazzband-standard contributing document. The README has also been updated with a mention of the Jazzband guidelines. --- CHANGES.rst | 52 +++++++++++++++++++++++++------------------------ CONTRIBUTING.md | 3 +++ README.rst | 8 +++++--- 3 files changed, 35 insertions(+), 28 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CHANGES.rst b/CHANGES.rst index 91a5dd4..8855e33 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -3,9 +3,11 @@ Changelog 1.5.1 (in development) ---------------------- +* `#135`_ Updated README with Jazzband details, and added CONTRIBUTING.md * `#136`_ Dropped support for Python 2.6 and 3.3, and Django < 1.11 -.. _#136: https://github.com/gregmuellegger/django-sortedm2m/pull/136 +.. _#135: https://github.com/jazzband/django-sortedm2m/pull/135 +.. _#136: https://github.com/jazzband/django-sortedm2m/pull/136 1.5.0 ----- @@ -15,8 +17,8 @@ Changelog * `#87`_: Fix ``AlterSortedManyToManyField`` operation to support custom set ``_sort_field_name``. -.. _#101: https://github.com/gregmuellegger/django-sortedm2m/pull/101 -.. _#87: https://github.com/gregmuellegger/django-sortedm2m/issues/87 +.. _#101: https://github.com/jazzband/django-sortedm2m/pull/101 +.. _#87: https://github.com/jazzband/django-sortedm2m/issues/87 1.4.0 ----- @@ -29,9 +31,9 @@ Changelog ``ManyToManyField`` instead of ``SortedManyToManyField`` from ``sortedm2m``. Thanks Dayne May for the patch. -.. _#104: https://github.com/gregmuellegger/django-sortedm2m/pull/104 -.. _#94: https://github.com/gregmuellegger/django-sortedm2m/pull/94 -.. _#93: https://github.com/gregmuellegger/django-sortedm2m/pull/93 +.. _#104: https://github.com/jazzband/django-sortedm2m/pull/104 +.. _#94: https://github.com/jazzband/django-sortedm2m/pull/94 +.. _#93: https://github.com/jazzband/django-sortedm2m/pull/93 1.3.3 ----- @@ -39,8 +41,8 @@ Changelog * `#91`_ & `#92`_: Fix admin widget, when used with Django 1.10. The add a new item opup was not closing. Thanks to Tipuch for the patch. -.. _#91: https://github.com/gregmuellegger/django-sortedm2m/issues/91 -.. _#92: https://github.com/gregmuellegger/django-sortedm2m/pull/92 +.. _#91: https://github.com/jazzband/django-sortedm2m/issues/91 +.. _#92: https://github.com/jazzband/django-sortedm2m/pull/92 1.3.2 ----- @@ -48,8 +50,8 @@ Changelog * `#80`_ & `#83`_: Fix ``SortedMultipleChoiceField.clean`` if the validated value is ``None``. Thanks to Alex Mannhold for the patch. -.. _#80: https://github.com/gregmuellegger/django-sortedm2m/issues/80 -.. _#83: https://github.com/gregmuellegger/django-sortedm2m/pull/83 +.. _#80: https://github.com/jazzband/django-sortedm2m/issues/80 +.. _#83: https://github.com/jazzband/django-sortedm2m/pull/83 1.3.1 ----- @@ -57,8 +59,8 @@ Changelog * `#57`_ & `#81`_: Fix add related object popup error prevents operation when no related objects already exist. Thanks to Vadim Sikora for the fix. -.. _#57: https://github.com/gregmuellegger/django-sortedm2m/issue/57 -.. _#81: https://github.com/gregmuellegger/django-sortedm2m/pull/81 +.. _#57: https://github.com/jazzband/django-sortedm2m/issue/57 +.. _#81: https://github.com/jazzband/django-sortedm2m/pull/81 1.3.0 ----- @@ -74,8 +76,8 @@ Changelog * `#76`_: Add support for to_field_name to SortedMultipleChoiceField. Thanks to Conrad Kramer for the patch. -.. _#76: https://github.com/gregmuellegger/django-sortedm2m/pull/76 -.. _#79: https://github.com/gregmuellegger/django-sortedm2m/pull/79 +.. _#76: https://github.com/jazzband/django-sortedm2m/pull/76 +.. _#79: https://github.com/jazzband/django-sortedm2m/pull/79 1.2.2 ----- @@ -83,7 +85,7 @@ Changelog * `#75`_: Fix "add another" admin popup. It didn't refresh the list of items in Django 1.8+. Thanks to Vadim Sikora for the patch. -.. _#75: https://github.com/gregmuellegger/django-sortedm2m/pull/75 +.. _#75: https://github.com/jazzband/django-sortedm2m/pull/75 1.2.1 ----- @@ -103,7 +105,7 @@ Changelog ``SortedCheckboxSelectMultiple``. Thanks to Kirill Ermolov for the patch. -.. _#71: https://github.com/gregmuellegger/django-sortedm2m/issues/71 +.. _#71: https://github.com/jazzband/django-sortedm2m/issues/71 1.1.1 ----- @@ -111,7 +113,7 @@ Changelog * `#70`_: CSS fix for Django 1.9 new admin design. Thanks to Maarten Draijer for the patch. -.. _#70: https://github.com/gregmuellegger/django-sortedm2m/pull/70 +.. _#70: https://github.com/jazzband/django-sortedm2m/pull/70 1.1.0 ----- @@ -122,10 +124,10 @@ Changelog decided by Django's DB router (with the ``allow_migrate_model`` method). Thanks to @hstanev for the patch. -.. _#59: https://github.com/gregmuellegger/django-sortedm2m/pull/59 -.. _#65: https://github.com/gregmuellegger/django-sortedm2m/pull/65 -.. _#67: https://github.com/gregmuellegger/django-sortedm2m/pull/67 -.. _#68: https://github.com/gregmuellegger/django-sortedm2m/pull/68 +.. _#59: https://github.com/jazzband/django-sortedm2m/pull/59 +.. _#65: https://github.com/jazzband/django-sortedm2m/pull/65 +.. _#67: https://github.com/jazzband/django-sortedm2m/pull/67 +.. _#68: https://github.com/jazzband/django-sortedm2m/pull/68 1.0.2 ----- @@ -136,7 +138,7 @@ Changelog added objects will be in order. Thanks to Scott Kyle for the report and patch. -.. _#56: https://github.com/gregmuellegger/django-sortedm2m/pull/56 +.. _#56: https://github.com/jazzband/django-sortedm2m/pull/56 1.0.1 ----- @@ -144,7 +146,7 @@ Changelog * Performance fix for sorted m2m admin widget. See `#54`_ for details. Thanks to Jonathan Liuti for fixing this. -.. _#54: https://github.com/gregmuellegger/django-sortedm2m/pull/54 +.. _#54: https://github.com/jazzband/django-sortedm2m/pull/54 1.0.0 ----- @@ -166,7 +168,7 @@ Changelog ``sort_value_field_name`` in Django 1.7 migrations. Thanks to Christian Kohlstedde for the patch. -.. _#49: https://github.com/gregmuellegger/django-sortedm2m/issues/49 +.. _#49: https://github.com/jazzband/django-sortedm2m/issues/49 0.9.5 ----- @@ -174,7 +176,7 @@ Changelog * Fixing ``setup.py`` when run on a system that does not use UTF-8 as default encoding. See `#48`_ for details. Thanks to Richard Mitchell for the patch. -.. _#48: https://github.com/gregmuellegger/django-sortedm2m/pull/48 +.. _#48: https://github.com/jazzband/django-sortedm2m/pull/48 0.9.4 ----- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ad78220 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/) + +This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines). diff --git a/README.rst b/README.rst index 75cf4c1..7a509d2 100644 --- a/README.rst +++ b/README.rst @@ -172,11 +172,13 @@ Example:: Contribute ========== +This is a `Jazzband `_ project. By contributing you agree to abide by the +`Contributor Code of Conduct `_ and follow the +`guidelines `_. -You can find the latest development version on github_. Get there and fork it, -file bugs or send me nice wishes. +You can find the latest development version on Github_. Get there and fork it, file bugs or send well wishes. -.. _github: http://github.com/gregmuellegger/django-sortedm2m +.. _github: http://github.com/jazzband/django-sortedm2m Running the tests -----------------