<commit_before>=============================
Contributing to pulse2percept
=============================

.. note::

    If you found a bug or want to request a feature, please open an issue in our
    `Issue Tracker`_ on GitHub.

.. _Issue Tracker: https://github.com/pulse2percept/pulse2percept/issues

We are excited that you are here and want to contribute!

Already know what you're looking for in this guide? Jump to the following
sections:

*   `Recommended workflow`_
*   `Contributing code`_
*   `Documenting your code`_
*   `Documenting API changes`_
*   `Testing your code`_

.. _dev-contributing-workflow:

Recommended workflow
====================

We appreciate all contributions, but those accepted fastest will follow a
workflow similar to the following:

1.  **GitHub account**:
    Before getting started, you will need to set up a free `GitHub account`_.

2.  **Claim an issue on GitHub**:
    Check the `Issue Tracker`_ to find an issue you want to work on, and add a
    comment announcing your intention to work on it.
    This allows other members of the development team to confirm that you
    aren't overlapping with existing work and that everyone is on the same page
    with the goal of your proposed work.

    .. image:: https://img.shields.io/badge/-bug-fc2929.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/bug
       :alt: Bug
       :align: left

    These issues point to problems in the project.

    .. image:: https://img.shields.io/badge/-enhancement-00FF09.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/enhancement
       :alt: Enhancement
       :align: left

    These issues are asking for new features to be added to the project.

    .. image:: https://img.shields.io/badge/-doc-FEF2C0.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/doc
       :alt: Documentation
       :align: left

    These issues concern the documentation / user guide of the project.

    .. image:: https://img.shields.io/badge/-help%20wanted-c2e0c6.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/help-wanted
       :alt: Help wanted
       :align: left

    These issues contain a task that a member of the team has determined we
    need additional help with.

    .. image:: https://img.shields.io/badge/-good%20first%20issue-5fe28d.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/good-first-issue
       :alt: Good first issue
       :align: left

    These issues are good entry points if you're new to the project and should
    only require minimal code changes.    

3.  **Fork the repo**:
    Follow the :ref:`Installation Guide <install-source>` to fork the repo and
    install all developer dependencies.
    This is now your own unique pulse2percept copy - changes here won't affect
    anyone else's work.
    Make sure to keep your code up-to-date
    with the :ref:`upstream repository <install-upgrade>`.

4.  **Create a new branch**:
    You should always work on a `new branch`_ on your fork.
    Once you made the code changes, "git add" and "git commit" them, and then
    "git push" them to your remote repository on GitHub.

    .. important::

        All code additions must be :ref:`documented <dev-contributing-doc>` and
        :ref:`tested <dev-contributing-test>`.<commit_msg>[DOC] Fix contribution guidelines formatting issues<commit_after>=============================
Contributing to pulse2percept
=============================

.. note::

    If you found a bug or want to request a feature, please open an issue in our
    `Issue Tracker`_ on GitHub.

.. _Issue Tracker: https://github.com/pulse2percept/pulse2percept/issues

We are excited that you are here and want to contribute!

Already know what you're looking for in this guide? Jump to the following
sections:

*   `Recommended workflow`_
*   `Contributing code`_
*   `Documenting your code`_
*   `Documenting API changes`_
*   `Testing your code`_

.. _dev-contributing-workflow:

Recommended workflow
====================

We appreciate all contributions, but those accepted fastest will follow a
workflow similar to the following:

1.  **GitHub account**:
    Before getting started, you will need to set up a free `GitHub account`_.

2.  **Claim an issue on GitHub**:
    Check the `Issue Tracker`_ to find an issue you want to work on, and add a
    comment announcing your intention to work on it.
    This allows other members of the development team to confirm that you
    aren't overlapping with existing work and that everyone is on the same page
    with the goal of your proposed work.

    .. image:: https://img.shields.io/badge/-bug-fc2929.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/bug
       :alt: Bug
       :align: left

    These issues point to problems in the project.
    The bug report should already contain steps for you to reproduce the issue.
    Make sure to include a :ref:`test case <dev-contributing-test>` verifying
    that the issue was indeed solved.

    .. image:: https://img.shields.io/badge/-enhancement-00FF09.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/enhancement
       :alt: Enhancement
       :align: left

    These issues are asking for new features to be added to the project.
    Make sure to include a :ref:`test case <dev-contributing-test>` for every
    new function/class that you write.
    Each API change should be :ref:`annotated in the docstring 
    <dev-contributing-changes>`.

    .. image:: https://img.shields.io/badge/-doc-FEF2C0.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/doc
       :alt: Documentation
       :align: left

    These issues concern the documentation / user guide of the project.
    Code changes should therefore be limited to the user guide and docstrings
    only.

    .. image:: https://img.shields.io/badge/-help%20wanted-c2e0c6.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/help-wanted
       :alt: Help wanted
       :align: left

    These issues contain a task that a member of the team has determined we
    need additional help with.

    .. image:: https://img.shields.io/badge/-good%20first%20issue-5fe28d.svg
       :target: https://github.com/pulse2percept/pulse2percept/labels/good-first-issue
       :alt: Good first issue
       :align: left

    These issues are good entry points if you're new to the project.
    They usually require only minimal code changes or are restricted to a
    single file.
    If you run into trouble, add a comment to the issue on GitHub or reach out
    to `@mbeyeler`_ and/or `@arokem`_ directly.

3.  **Fork the repo**:
    Follow the :ref:`Installation Guide <install-source>` to fork the repo and
    install all developer dependencies.
    This is now your own unique pulse2percept copy - changes here won't affect
    anyone else's work.
    Make sure to keep your code up-to-date
    with the :ref:`upstream repository <install-upgrade>`.

4.  **Create a new branch**:
    You should always work on a `new branch`_ on your fork.
    Once you made the code changes, "git add" and "git commit" them, and then
    "git push" them to your remote repository on GitHub.

    .. important::

        All code additions must be :ref:`documented <dev-contributing-doc>` and
        :ref:`tested <dev-contributing-test>`.
{'fraction_non_alphanumeric': 0.10453994341910279, 'fraction_numerical': 0.010777313754546679, 'mean_word_length': 3.175478065241845, 'pattern_counts': {'":': 0, '<': 14, '<?xml version=': 0, '>': 14, 'https://': 22, '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': '4070000', 'n_tokens_mistral': 2232, 'n_tokens_neox': 2067, 'n_words': 838}