mirror of
https://github.com/jazzband/django-downloadview.git
synced 2026-03-16 22:40:25 +00:00
102 lines
2.7 KiB
ReStructuredText
102 lines
2.7 KiB
ReStructuredText
############
|
|
Contributing
|
|
############
|
|
|
|
|
|
.. 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>`_.
|
|
|
|
|
|
This document provides guidelines for people who want to contribute to
|
|
``django-downloadview``.
|
|
|
|
|
|
**************
|
|
Create tickets
|
|
**************
|
|
|
|
Please use the `bugtracker`_ **before** starting some work:
|
|
|
|
* check if the bug or feature request has already been filed. It may have been
|
|
answered too!
|
|
|
|
* else create a new ticket.
|
|
|
|
* if you plan to contribute, tell us, so that we are given an opportunity to
|
|
give feedback as soon as possible.
|
|
|
|
* Then, in your commit messages, reference the ticket with some
|
|
``refs #TICKET-ID`` syntax.
|
|
|
|
|
|
******************
|
|
Use topic branches
|
|
******************
|
|
|
|
* Work in branches.
|
|
|
|
* Prefix your branch with the ticket ID corresponding to the issue. As an
|
|
example, if you are working on ticket #23 which is about contribute
|
|
documentation, name your branch like ``23-contribute-doc``.
|
|
|
|
* If you work in a development branch and want to refresh it with changes from
|
|
master, please `rebase`_ or `merge-based rebase`_, i.e. do not merge master.
|
|
|
|
|
|
***********
|
|
Fork, clone
|
|
***********
|
|
|
|
Clone ``django-downloadview`` repository (adapt to use your own fork):
|
|
|
|
.. code:: sh
|
|
|
|
git clone git@github.com:jazzband/django-downloadview.git
|
|
cd django-downloadview/
|
|
|
|
|
|
*************
|
|
Usual actions
|
|
*************
|
|
|
|
The ``Makefile`` is the reference card for usual actions in development
|
|
environment:
|
|
|
|
* Install development toolkit with `pip`_: ``make develop``.
|
|
|
|
* Run tests with `tox`_: ``make test``.
|
|
|
|
* Build documentation: ``make documentation``. It builds `Sphinx`_
|
|
documentation in ``var/docs/html/index.html``.
|
|
|
|
* Release project with `zest.releaser`_: ``make release``.
|
|
|
|
* Cleanup local repository: ``make clean``, ``make distclean`` and
|
|
``make maintainer-clean``.
|
|
|
|
See also ``make help``.
|
|
|
|
|
|
*********************
|
|
Demo project included
|
|
*********************
|
|
|
|
The ``demo`` included in project's repository is part of the tests and
|
|
documentation. Maintain it along with code and documentation.
|
|
|
|
|
|
.. rubric:: Notes & references
|
|
|
|
.. target-notes::
|
|
|
|
.. _`bugtracker`:
|
|
https://github.com/jazzband/django-downloadview/issues
|
|
.. _`rebase`: http://git-scm.com/book/en/Git-Branching-Rebasing
|
|
.. _`merge-based rebase`: https://tech.people-doc.com/psycho-rebasing.html
|
|
.. _`pip`: https://pypi.python.org/pypi/pip/
|
|
.. _`tox`: https://tox.readthedocs.io/
|
|
.. _`Sphinx`: https://pypi.python.org/pypi/Sphinx/
|
|
.. _`zest.releaser`: https://pypi.python.org/pypi/zest.releaser/
|