Contributor’s Guide

Steps for Submitting Code

Contributions are very much welcomed and appreciated. Every little bit of help counts, so do not hesitate!

  1. Check for open issues, or open a new issue to start some discussion around a feature idea or bug. There is a contributor friendly tag for issues that should be ideal for people who are not familiar with the codebase yet.

  2. Fork the repository on GitHub to start making your changes.

  3. Write some tests that show the bug is fixed or that the feature works as expected.

  4. Ensure your code passes the style checks by running

$ black questionary
  1. Check all of the unit tests pass by running

$ pytest --pycodestyle --cov questionary -v
  1. Check the type checks pass by running

$ mypy questionary
  1. Send a pull request and bug the maintainer until it gets merged and published 🙂

Bug Reports

Bug reports should be made to the issue tracker. Please include enough information to reproduce the issue you are having. A minimal, reproducible example would be very helpful.

Feature Requests

Feature requests should be made to the issue tracker.


Create a New Release

  1. Update the version number in questionary/ and pyproject.toml.

  2. Add a new section for the release to Changelog.

  3. Commit these changes.

  4. git tag the commit with the release version number.

GitHub Actions will build and push the updated library to PyPi.

Create a Command Line Recording

  1. Install the following tools:

    $ brew install asciinema
    $ npm install --global asciicast2gif
  2. Start the recording with asciinema:
    $ asciinema rec
  3. Do the thing you want to record.

  4. Convert to gif using asciicast2gif:
    $ asciicast2gif -h 7 -w 120 -s 2 <recording> output.gif