<commit_before>Contributing
============

If you've found a bug, have an idea for a feature, or have a comment or other
question, we would love to hear from you. Search the Issues_ to see if anyone
else has run into the same thing. If so, add onto that issue. Otherwise, start
your own issue. Thanks for your thoughts!

If you want to implement the change yourself (that would be awesome!) then
continue...

Get the Code
------------

Fork the `staticjinja/staticjinja`_ repository on GitHub. Clone a copy of your
fork, install all the dependencies, and then install tox_ for testing:

.. code-block:: bash

    $ cd $HOME/projects
    $ git clone git://github.com/{YOUR_USERNAME}/staticjinja.git
    $ cd staticjinja
    $ python -m pip install --upgrade pip
    $ pip install -r requirements.txt
    $ pip install tox

Making Changes
--------------

Start making edits! If you need to test these changes against your personal
project, then you'll need to install the local, modified version of
staticjinja for your project to use. Do this by running

.. code-block:: bash

    $ python setup.py install

whenever you make edits. There might be a better way to do this, but IDK what
it is. Please file an Issues_ if you know!

Testing your Changes
--------------------

You should test your changes with tox_:<commit_msg>docs: Fix CONTRIBUTING advice on installing as editable<commit_after>Contributing
============

If you've found a bug, have an idea for a feature, or have a comment or other
question, we would love to hear from you. Search the Issues_ to see if anyone
else has run into the same thing. If so, add onto that issue. Otherwise, start
your own issue. Thanks for your thoughts!

If you want to implement the change yourself (that would be awesome!) then
continue...

Get the Code
------------

Fork the `staticjinja/staticjinja`_ repository on GitHub. Clone a copy of your
fork, install all the dependencies, and then install tox_ for testing:

.. code-block:: bash

    $ cd $HOME/projects
    $ git clone git://github.com/{YOUR_USERNAME}/staticjinja.git
    $ cd staticjinja
    $ python -m pip install --upgrade pip
    $ pip install -r requirements.txt
    $ pip install tox

Making Changes
--------------

Start making edits! If you want to test your personal project on your changes,
then you'll want to install staticjinja as ``editable``. Then your project
will use the local, edited version of staticjinja.

.. code-block:: bash

    $ python3 -m pip install -e .

Testing your Changes
--------------------

You should test your changes with tox_:
{'fraction_non_alphanumeric': 0.10182666148464826, 'fraction_numerical': 0.000388651379712398, 'mean_word_length': 3.0922098569157392, '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': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3343153', 'n_tokens_mistral': 720, 'n_tokens_neox': 673, 'n_words': 366}