Merge pull request #139 from jazzband/prepare-jazzband

Implement Jazzband guidelines
This commit is contained in:
Jannis Leidel 2018-11-30 10:18:37 +01:00 committed by GitHub
commit 456ab03a7d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 43 additions and 27 deletions

View file

@ -1,11 +1,12 @@
The django-analytical package was written by `Joost Cassee`_, with
contributions from `Eric Davis`_, `Paul Oswald`_, `Uros Trebec`_,
`Steven Skoczen`_, `Pi Delport`_, `Sandra Mau`_, `Simon Ye`_,
`Tinnet Coronam`_, `Philippe O. Wagner`_, `Max Arnold`_ , `Martín
Gaitán`_, `Craig Bruce`_, `Peter Bittner`_, `Scott Adams`_, `Eric Amador`_,
`Alexandre Pocquet`_, `Brad Pitcher`_, `Hugo Osvaldo Barrera`_,
`Nikolay Korotkiy`_, `Steve Schwarz`_, `Aleck Landgraf`_,
`Marc Bourqui`_, `Diederik van der Boor`_, `Matthäus G. Chajdas`_ and others.
The django-analytical package was originally written by `Joost Cassee`_
and is now maintained by the `Jazzband community`_, with contributions
from `Eric Davis`_, `Paul Oswald`_, `Uros Trebec`_, `Steven Skoczen`_,
`Pi Delport`_, `Sandra Mau`_, `Simon Ye`_, `Tinnet Coronam`_,
`Philippe O. Wagner`_, `Max Arnold`_ , `Martín Gaitán`_, `Craig Bruce`_,
`Peter Bittner`_, `Scott Adams`_, `Eric Amador`_, `Alexandre Pocquet`_,
`Brad Pitcher`_, `Hugo Osvaldo Barrera`_, `Nikolay Korotkiy`_,
`Steve Schwarz`_, `Aleck Landgraf`_, `Marc Bourqui`_,
`Diederik van der Boor`_, `Matthäus G. Chajdas`_ and others.
Included Javascript code snippets for integration of the analytics
services were written by the respective service providers.
@ -17,6 +18,7 @@ The work on Crazy Egg was made possible by `Bateau Knowledge`_.
The work on Intercom was made possible by `GreenKahuna`_.
.. _`Joost Cassee`: https://github.com/jcassee
.. _`Jazzband community`: https://jazzband.co/
.. _`Eric Davis`: https://github.com/edavis
.. _`Paul Oswald`: https://github.com/poswald
.. _`Uros Trebec`: https://github.com/failedguidedog

5
CONTRIBUTING.rst Normal file
View file

@ -0,0 +1,5 @@
.. 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>`_.

View file

@ -1,7 +1,7 @@
django-analytical |latest-version|
==================================
|travis-ci| |coveralls| |health| |python-support| |license| |gitter|
|travis-ci| |coveralls| |health| |python-support| |license| |gitter| |jazzband|
The django-analytical application integrates analytics services into a
Django_ project.
@ -26,24 +26,27 @@ an asynchronous version of the Javascript code if possible.
.. |latest-version| image:: https://img.shields.io/pypi/v/django-analytical.svg
:alt: Latest version on PyPI
:target: https://pypi.python.org/pypi/django-analytical
.. |travis-ci| image:: https://img.shields.io/travis/jcassee/django-analytical/master.svg
.. |travis-ci| image:: https://img.shields.io/travis/jazzband/django-analytical/master.svg
:alt: Build status
:target: https://travis-ci.org/jcassee/django-analytical
.. |coveralls| image:: https://coveralls.io/repos/jcassee/django-analytical/badge.svg
:target: https://travis-ci.org/jazzband/django-analytical
.. |coveralls| image:: https://coveralls.io/repos/jazzband/django-analytical/badge.svg
:alt: Test coverage
:target: https://coveralls.io/r/jcassee/django-analytical
.. |health| image:: https://landscape.io/github/jcassee/django-analytical/master/landscape.svg?style=flat
:target: https://landscape.io/github/jcassee/django-analytical/master
:target: https://coveralls.io/r/jazzband/django-analytical
.. |health| image:: https://landscape.io/github/jazzband/django-analytical/master/landscape.svg?style=flat
:target: https://landscape.io/github/jazzband/django-analytical/master
:alt: Code health
.. |python-support| image:: https://img.shields.io/pypi/pyversions/django-analytical.svg
:target: https://pypi.python.org/pypi/django-analytical
:alt: Python versions
.. |license| image:: https://img.shields.io/pypi/l/django-analytical.svg
:alt: Software license
:target: https://github.com/jcassee/django-analytical/blob/master/LICENSE.txt
:target: https://github.com/jazzband/django-analytical/blob/master/LICENSE.txt
.. |gitter| image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Gitter chat room
:target: https://gitter.im/jcassee/django-analytical
:target: https://gitter.im/jazzband/django-analytical
.. |jazzband| image:: https://jazzband.co/static/img/badge.svg
:alt: Jazzband
:target: https://jazzband.co/
.. _`Django`: http://www.djangoproject.com/
Currently Supported Services
@ -109,8 +112,8 @@ and coding support when implementing new service integrations you're
welcome to use our `Gitter chat room`_.
.. _`read online`: https://django-analytical.readthedocs.io/
.. _`hosted by GitHub`: https://github.com/jcassee/django-analytical
.. _`Gitter chat room`: https://gitter.im/jcassee/django-analytical
.. _`hosted by GitHub`: https://github.com/jazzband/django-analytical
.. _`Gitter chat room`: https://gitter.im/jazzband/django-analytical
How To Contribute
-----------------
@ -124,7 +127,13 @@ services to support, or suggesting documentation improvements, use the
the repository, make changes and place a `pull request`_. Creating an
issue to discuss your plans is useful.
.. _`issue tracker`: https://github.com/jcassee/django-analytical/issues
.. _`pull request`: https://github.com/jcassee/django-analytical/pulls
This is a `Jazzband`_ project. By contributing you agree to abide by the
`Contributor Code of Conduct`_ and follow the `guidelines`_.
.. _`issue tracker`: https://github.com/jazzband/django-analytical/issues
.. _`pull request`: https://github.com/jazzband/django-analytical/pulls
.. _`Jazzband`: https://jazzband.co
.. _`Contributor Code of Conduct`: https://jazzband.co/about/conduct
.. _`guidelines`: https://jazzband.co/about/guidelines
.. end contribute include

View file

@ -8,7 +8,7 @@ Django_ project.
.. _Django: https://www.djangoproject.com/
:Package: https://pypi.python.org/pypi/django-analytical/
:Source: https://github.com/jcassee/django-analytical
:Source: https://github.com/jazzband/django-analytical
Overview

View file

@ -32,10 +32,10 @@ get the development code:
.. code-block:: bash
$ git clone https://github.com/jcassee/django-analytical.git
$ git clone https://github.com/jazzband/django-analytical.git
.. _PyPI: http://pypi.python.org/pypi/django-analytical/
.. _GitHub: http://github.com/jcassee/django-analytical
.. _GitHub: http://github.com/jazzband/django-analytical
Then install the package by running the setup script:

View file

@ -13,7 +13,7 @@ If you would like to have another analytics service supported by
django-analytical, please create an issue on the project
`issue tracker`_. See also :ref:`helping-out`.
.. _`issue tracker`: http://github.com/jcassee/django-analytical/issues
.. _`issue tracker`: http://github.com/jazzband/django-analytical/issues
Currently supported services:

View file

@ -96,8 +96,8 @@ setup(
'Programming Language :: Python :: 3.7',
],
platforms=['any'],
url='https://github.com/jcassee/django-analytical',
download_url='https://github.com/jcassee/django-analytical/archive/master.zip',
url='https://github.com/jazzband/django-analytical',
download_url='https://github.com/jazzband/django-analytical/archive/master.zip',
cmdclass=cmdclass,
install_requires=[
'Django>=1.7.0',