andreoliwa/nitpick

.. include:: targets.rst

============
Contributing
============

Contributions are welcome, and they are greatly appreciated!
Every little bit helps, and credit will always be given.

Check the `projects on GitHub <https://github.com/andreoliwa/nitpick/projects>`_, you might help coding a planned feature.

Bug reports or feature requests
===============================

* First, search the `GitHub issue tracker <https://github.com/andreoliwa/nitpick/issues>`_ to see if your bug/feature is already there.
* If nothing is found, just :issue:`add a new issue and follow the instructions <new/choose>`.

Documentation improvements
==========================

Nitpick_ could always use more documentation, whether as part of the
official docs, in docstrings, or even on the web in blog posts,
articles, and such.

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

To set up Nitpick_ for local development:

1. Fork Nitpick_ (look for the "Fork" button).

2. Clone your fork locally::

    cd ~/Code
    git clone git@github.com:your_name_here/nitpick.git
    cd nitpick

3. Install Poetry_ globally using `the recommended way <https://python-poetry.org/docs/#installation>`_.

4. Install Invoke_. You can use pipx_ to install it globally: ``pipx install invoke``.

5. Install dependencies and pre-commit_ hooks::

    invoke install --hooks

6. Create a branch for local development::

    git checkout -b name-of-your-bugfix-or-feature

   Now you can make your changes locally.

7. When you're done making changes, run tests and checks locally with::

    # Quick tests and checks
    make
    # Or use this to simulate a full CI build with tox
    invoke ci-build

8. Commit your changes and push your branch to GitHub::

    git add .

    # For a feature:
    git commit -m "feat: short description of your feature"
    # For a bug fix:
    git commit -m "fix: short description of what you fixed"

    git push origin name-of-your-bugfix-or-feature

9. Submit a pull request through the GitHub website.

Commit convention
-----------------

Nitpick_ follows `Conventional Commits <https://www.conventionalcommits.org/>`_

No need to rebase the commits in your branch.
If your pull request is accepted, all your commits will be squashed into a single one, and the commit message will be adjusted to follow the current standard.

Pull Request Guidelines
-----------------------

If you need some code review or feedback while you're developing the code, just make a draft pull request.

For merging, follow the checklist on the pull request template itself.

When running ``invoke test``: if you don't have all the necessary Python versions available locally (needed by tox_), you can rely on GitHub Workflows.
`Tests will run <https://github.com/andreoliwa/nitpick/actions/workflows/python.yaml>`_ for each change you add in the pull request.
It will be slower though...