Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented Jazzband guidelines #501

Merged
merged 4 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
repos: []
2 changes: 1 addition & 1 deletion CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ v0.16.0
- Using strings as cache keys instead of bytes
- Passing effects of test decorator to child classes
-- NOTE: This introduced a backwards-incompatible change for the testutils override decorators.
See https://github.com/django-waffle/django-waffle/pull/331 for details.
See https://github.com/jazzband/django-waffle/pull/331 for details.

v0.15.1
=======
Expand Down
12 changes: 10 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
Contributing to Waffle
======================

.. image:: https://jazzband.co/static/img/jazzband.svg
:target: https://jazzband.co/
:alt: Jazzband

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>`_.

Waffle is pretty simple to hack, and has a decent test suite! Here's how
to patch Waffle, add tests, run them, and contribute changes.

Expand Down Expand Up @@ -70,8 +78,8 @@ Regressions tests should fail without the rest of the patch and pass
with it.


.. _open a new issue: https://github.com/django-waffle/django-waffle/issues/new
.. _Fork: https://github.com/django-waffle/django-waffle/fork
.. _open a new issue: https://github.com/jazzband/django-waffle/issues/new
.. _Fork: https://github.com/jazzband/django-waffle/fork
.. _flake8: https://pypi.python.org/pypi/flake8
.. _mypy: https://www.mypy-lang.org/
.. _good commit message: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
11 changes: 7 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@ Django Waffle is (yet another) feature flipper for Django. You can
define the conditions for which a flag should be active, and use it in
a number of ways.

.. image:: https://github.com/django-waffle/django-waffle/workflows/Python%20package/badge.svg?branch=master
:target: https://github.com/django-waffle/django-waffle/actions
.. image:: https://jazzband.co/static/img/badge.svg
:target: https://jazzband.co/
:alt: Jazzband
.. image:: https://github.com/jazzband/django-waffle/workflows/Python%20package/badge.svg?branch=master
:target: https://github.com/jazzband/django-waffle/actions
:alt: Build Status
.. image:: https://badge.fury.io/py/django-waffle.svg
:target: https://badge.fury.io/py/django-waffle
:alt: PyPI status badge

:Code: https://github.com/django-waffle/django-waffle
:Code: https://github.com/jazzband/django-waffle
:License: BSD; see LICENSE file
:Issues: https://github.com/django-waffle/django-waffle/issues
:Issues: https://github.com/jazzband/django-waffle/issues
:Documentation: https://waffle.readthedocs.io/
6 changes: 3 additions & 3 deletions docs/about/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ To be mergeable, patches must:
- have a `good commit message`_.

Regressions tests should fail without the rest of the patch and pass
with it.
with it.


.. _open a new issue: https://github.com/django-waffle/django-waffle/issues/new
.. _Fork: https://github.com/django-waffle/django-waffle/fork
.. _open a new issue: https://github.com/jazzband/django-waffle/issues/new
.. _Fork: https://github.com/jazzband/django-waffle/fork
.. _flake8: https://pypi.python.org/pypi/flake8
.. _good commit message: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
14 changes: 7 additions & 7 deletions docs/about/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,11 +119,11 @@ scratch today with slightly different goals, like extensibility. Beyond
kind of overhaul.


.. _milestones: https://github.com/django-waffle/django-waffle/milestones
.. _0.10.2: https://github.com/django-waffle/django-waffle/milestones/0.10.2
.. _0.11: https://github.com/django-waffle/django-waffle/milestones/0.11
.. _0.11.x: https://github.com/django-waffle/django-waffle/milestones/0.11.x
.. _0.12: https://github.com/django-waffle/django-waffle/milestones/0.12
.. _0.13: https://github.com/django-waffle/django-waffle/milestones/0.13
.. _milestones: https://github.com/jazzband/django-waffle/milestones
.. _0.10.2: https://github.com/jazzband/django-waffle/milestones/0.10.2
.. _0.11: https://github.com/jazzband/django-waffle/milestones/0.11
.. _0.11.x: https://github.com/jazzband/django-waffle/milestones/0.11.x
.. _0.12: https://github.com/jazzband/django-waffle/milestones/0.12
.. _0.13: https://github.com/jazzband/django-waffle/milestones/0.13
.. _Gargoyle: https://github.com/disqus/gargoyle
.. _django-jinja: https://niwinz.github.io/django-jinja/latest/
.. _django-jinja: https://niwinz.github.io/django-jinja/latest/
4 changes: 2 additions & 2 deletions docs/about/why-waffle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ here, let me know or add yourself in a pull request!)

.. _Feature flags: http://code.flickr.net/2009/12/02/flipping-out/
.. _several options: https://www.djangopackages.com/grids/g/feature-flip/
.. _active community: https://github.com/django-waffle/django-waffle/graphs/contributors
.. _fairly steady updates: https://github.com/django-waffle/django-waffle/pulse/monthly
.. _active community: https://github.com/jazzband/django-waffle/graphs/contributors
.. _fairly steady updates: https://github.com/jazzband/django-waffle/pulse/monthly
.. _Gargoyle: https://github.com/disqus/gargoyle
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Waffle is feature flipper for Django. You can define the conditions for
which a flag should be active, and use it in a number of ways.

:Version: |release|
:Code: https://github.com/django-waffle/django-waffle
:Code: https://github.com/jazzband/django-waffle
:License: BSD; see LICENSE file
:Issues: https://github.com/django-waffle/django-waffle/issues
:Issues: https://github.com/jazzband/django-waffle/issues

Contents:

Expand Down
2 changes: 1 addition & 1 deletion docs/starting/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Waffle is also available `on GitHub`_. In general, ``master`` should be
stable, but use caution depending on unreleased versions.

.. _hosted on PyPI: http://pypi.python.org/pypi/django-waffle
.. _on GitHub: https://github.com/django-waffle/django-waffle
.. _on GitHub: https://github.com/jazzband/django-waffle


.. _installation-settings:
Expand Down
2 changes: 1 addition & 1 deletion docs/testing/user.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,5 +160,5 @@ You can use similar methods to derive the impact on other factors.


.. _session variables: https://developers.google.com/analytics/devguides/collection/upgrade/reference/gajs-analyticsjs#custom-vars
.. _#80: https://github.com/django-waffle/django-waffle/issues/80
.. _#80: https://github.com/jazzband/django-waffle/issues/80
.. _StatsD: https://github.com/etsy/statsd
Loading