<commit_before>.. _ref-contributing:

Contributing to Pinax
=====================

We are always looking for people wanting to improve Pinax itself. This
document outlines the necessary bits to begin contributing to Pinax.

Getting started
---------------

The Pinax source code is hosted on GitHub_. This means you must have git_
installed locally. We recommend you create an account on GitHub allowing you
to watch and fork the Pinax source code.

You will want to be sure that your git configuration is set for making commits
to a repository. Check the following::

    git config user.name
    git config user.email

If the output of any of the two commands above are not entirely correct you
can easily correct them::

    git config --global user.name "<NAME>"
    git config --global user.name "<EMAIL>"

It is critical you set this information up correctly. It helps us identify
who you are when you start giving us those awesome patches.

Grabbing the source code
~~~~~~~~~~~~~~~~~~~~~~~~

Once you have forked the Pinax source code you can now make a clone of it to
your local disk. To do this::

    git clone <EMAIL>:<username>/pinax.git

This will create new directory named ``pinax`` which now contains the Pinax
source tree ready for you to get started.
<commit_msg>Fixed typo in contributing documentation<commit_after>.. _ref-contributing:

Contributing to Pinax
=====================

We are always looking for people wanting to improve Pinax itself. This
document outlines the necessary bits to begin contributing to Pinax.

Getting started
---------------

The Pinax source code is hosted on GitHub_. This means you must have git_
installed locally. We recommend you create an account on GitHub allowing you
to watch and fork the Pinax source code.

You will want to be sure that your git configuration is set for making commits
to a repository. Check the following::

    git config user.name
    git config user.email

If the output of any of the two commands above are not entirely correct you
can easily correct them::

    git config --global user.name "<NAME>"
    git config --global user.email "<EMAIL>"

It is critical you set this information up correctly. It helps us identify
who you are when you start giving us those awesome patches.

Grabbing the source code
~~~~~~~~~~~~~~~~~~~~~~~~

Once you have forked the Pinax source code you can now make a clone of it to
your local disk. To do this::

    git clone <EMAIL>:<username>/pinax.git

This will create new directory named ``pinax`` which now contains the Pinax
source tree ready for you to get started.

{'fraction_non_alphanumeric': 0.08494208494208494, 'fraction_numerical': 0.0, 'mean_word_length': 3.8070500927643787, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, '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': '620113', 'n_tokens_mistral': 644, 'n_tokens_neox': 617, 'n_words': 390}