Skip to content
This repository has been archived by the owner on May 9, 2024. It is now read-only.

Latest commit

 

History

History
155 lines (109 loc) · 4.98 KB

CONTRIBUTING.rst

File metadata and controls

155 lines (109 loc) · 4.98 KB

How to contribute to Minik

Thank you for considering contributing to Minik!

Reporting issues

  • Describe what you expected to happen.
  • If possible, include a minimal, complete, and verifiable example to help us identify the issue. This also helps check that the issue is not with your own code.
  • Describe what actually happened. Include the full traceback if there was an exception.
  • List your Python and Minik. If possible, check if this issue is already fixed in the repository.

Submitting patches

  • Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch.
  • Try to follow PEP8, but you may ignore the line length limit if following it would make the code uglier.
  • Keep in mind that minik is configured to use Flake8 for linting and the CI pipeline will fail for PEP8 related issues.

First time setup

  • Download and install the latest version of git.

  • Configure git with your username and email:

    git config --global user.name 'your name'
git config --global user.email 'your email'

  • Make sure you have a GitHub account.

  • Fork Minik to your GitHub account by clicking the Fork button.

  • Clone your GitHub fork locally:

    git clone https://github.com/{username}/minik
cd minik

  • Add the main repository as a remote to update later:

    git remote add minik https://github.com/eabglobal/minik
git fetch minik

  • Create a virtualenv:

    python3 -m venv env
. env/bin/activate
# or "env\Scripts\activate" on Windows

  • Install Minik in editable mode with development dependencies:

    pip install -e ".[dev]"

Start coding

  • Create a branch to identify the issue you would like to work on (e.g. 2287-dry-test-suite)
  • Using your favorite editor, make your changes, committing as you go.
  • Try to follow PEP8, but you may ignore the line length limit if following it would make the code uglier.
  • Include tests that cover any code changes you make. Make sure the test fails without your patch. Run the tests..
  • Push your commits to GitHub and create a pull request.
  • Celebrate 🎉

Running the tests

Run the basic test suite with:

pytest

This only runs the tests for the current environment.

Running test coverage

Generating a report of lines that do not have test coverage can indicate where to start contributing. Run pytest using coverage and generate a report on the terminal and as an interactive HTML document:

python -m pytest --cov .
coverage html
# then open htmlcov/index.html

Read more about coverage.

Running the full test suite with tox will combine the coverage reports from all runs.

Building the docs

Build the docs in the docs directory using Sphinx:

make docs

Open docs/_build/html/index.html in your browser to view the docs.

When updating the docs, it is convenient to have a local server pick up the latest changes in the documents. For this purposes phix is included in the dev dependencies.

>>> cd docs
>>> make html
>>> phix -t html -p 8001
# open the documentation at http://localhost:8001

Every changes you make to any .rst file inside the docs will trigger the rebuild of the documentatation and the recreation of the html artifacts.

Read more about Sphinx.

make targets

Minik provides a Makefile with various shortcuts. They will ensure that all dependencies are installed.

  • make test runs the basic test suite with pytest
  • make cov runs the basic test suite with coverage
  • make docs builds the HTML documentation

push to pypi

Before pushing any changes to the pypi please take a look at the steps defined in this documentation.

>>> python3 setup.py sdist bdist_wheel
>>> twine check dist/*
>>> python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
>>> twine upload dist/*