Contributing

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

Check the projects on GitHub, you might help coding a planned feature.

Bug reports or feature requests

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.

  4. Create your virtualenv with pyenv (or some other tool you prefer):

    pyenv virtualenv 3.5.6 nitpick
    pyenv activate nitpick
    
  5. Install packages:

    poetry install
    
    # Output:
    # Installing dependencies from lock file
    # ...
    
  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 pre-commit checks and tests with:

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

    git add .
    git commit -m "Your detailed description of your changes."
    git push origin name-of-your-bugfix-or-feature
    
  9. Submit a pull request through the GitHub website.

  10. If your pull request is accepted, all your commits will be squashed into one, and the Conventional Commits Format will be used on the commit message.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run make test) 1.

  2. Update documentation when there’s new API, functionality etc.

  3. Add yourself to AUTHORS.rst.

1

If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.

It will be slower though …