<commit_before>.. _development:

Development
===========

.. _get the code:

Get the code
------------

Please see the :ref:`source-code-checkouts` section of the :ref:`installation` page
for details on how to obtain Facepy's source code.

.. _contributing:

Contributing
------------

There are a number of ways to get involved with Facepy:

* **Report bugs.** If you think you've found a bug in Facepy, please let me know by
  creating a ticket on the `issue tracker`_.

* **Submit patches or new features.** Create a fork and send me a pull request on `Github`_!

Tests
-----

Facepy has an exhaustive test suite that you may run with `nose`_::

    $ nosetests

Releases
--------

Major
^^^^^

Major releases update the first number, e.g. going from 0.9 to 1.0, and indicate that the
software has reached some very large milestone.

Minor
^^^^^<commit_msg>Nitpicking<commit_after>.. _development:

Development
===========

.. _get the code:

Get the code
------------

Please see the :ref:`source-code-checkouts` section of the :ref:`installation` page
for details on how to obtain Facepy's source code.

.. _contributing:

Contributing
------------

There are a number of ways to get involved with Facepy:

* **Report bugs.** If you think you've found a bug in Facepy, please let me know by
  creating a ticket on the `issue tracker`_.

* **Submit patches or new features.** Create a fork and send me a pull request on `Github`_!

Tests
-----

Facepy has an exhaustive test suite that you should run with `nose`_::

    $ nosetests

Releases
--------

Major
^^^^^

Major releases update the first number, e.g. going from 0.9 to 1.0, and indicate that the
software has reached some very large milestone.

Minor
^^^^^
{'fraction_non_alphanumeric': 0.13372093023255813, 'fraction_numerical': 0.004651162790697674, 'mean_word_length': 3.1670702179176757, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '895302', 'n_tokens_mistral': 532, 'n_tokens_neox': 507, 'n_words': 238}