<commit_before>Development
===========

.. toctree::
   :hidden:

   standards


The :doc:`upgrading` documentation is also applicable to updating your
development checkout of MozTrap.


Community
---------

To connect with MozTrap development, visit the ``#moztrap`` IRC channel at
``irc.mozilla.org``, or see the `Pivotal Tracker backlog`_.

.. _Pivotal Tracker backlog: https://www.pivotaltracker.com/projects/280483


Coding standards
----------------

See the :doc:`standards` for help writing code that will maintain a consistent<commit_msg>added instructions for adding to documentation<commit_after>Development
===========

.. toctree::
   :hidden:

   standards


The :doc:`upgrading` documentation is also applicable to updating your
development checkout of MozTrap.


Community
---------

To connect with MozTrap development, visit the ``#moztrap`` IRC channel at
``irc.mozilla.org``, or see the `Pivotal Tracker backlog`_.

.. _Pivotal Tracker backlog: https://www.pivotaltracker.com/projects/280483


Updating this documentation
---------------------------

MozTrap documentation is hosted on ReadTheDocs.org and is maintained in the
MozTrap repo.  So updating the docs involves forking the repo, changing the
appropriate reStructuredText documents and submitting a pull request.  Then
the team will review them and merge them after any needed adjustments are made.

So here are your steps:

    #. fork the `MozTrap repo`_
    #. make any changes in the ``/docs`` folder using `Sphinx and
       reStructuredText`_ formatting
    #. test that your changes are correctly formatted by installing the python
       Sphinx package (in the repo's ``requirements.txt`` document) by typing
       ``make html`` in that same ``/docs`` folder
    #. load the file: ``/docs/_build/html/index.html`` into your browser
       (it's `Firefox`_, right?) to test your changes
    #. submit your pull request and it will be reviewed shortly
    #. receive a big thanks for helping!!

.. _MozTrap repo: https://github.com/mozilla/moztrap
.. _Sphinx and reStructuredText: http://sphinx-doc.org/rest.html
.. _Firefox: http://www.mozilla.org/en-US/firefox/new/


Coding standards
----------------

See the :doc:`standards` for help writing code that will maintain a consistent
{'fraction_non_alphanumeric': 0.12422907488986784, 'fraction_numerical': 0.0052863436123348016, 'mean_word_length': 3.4442270058708413, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 3, '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': '6232954', 'n_tokens_mistral': 675, 'n_tokens_neox': 621, 'n_words': 248}