Skip to content

Latest commit

 

History

History
225 lines (145 loc) · 6.48 KB

CONTRIBUTING.rst

File metadata and controls

225 lines (145 loc) · 6.48 KB
Raw

How to contribute to CacheLib

Thank you for considering contributing to CacheLib!

Support questions

Please don't use the issue tracker for this. The issue tracker is a tool to address bugs and feature requests in CacheLib itself. Use one of the following resources for questions about using CacheLib or issues with your own code:

Reporting issues

Include the following information in your post:

  • Describe what you expected to happen.
  • If possible, include a minimal reproducible 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 CacheLib versions. If possible, check if this issue is already fixed in the latest releases or the latest code in the repository.

Submitting patches

If there is not an open issue for what you want to submit, prefer opening one for discussion before working on a PR. You can work on any issue that doesn't have an open PR linked to it or a maintainer assigned to it. These show up in the sidebar. No need to ask if you can work on an issue that interests you.

Include the following in your patch:

  • Use Black to format your code. This and other tools will run automatically if you install pre-commit using the instructions below.
  • Include tests if your patch adds or changes code. Make sure the test fails without your patch.
  • Update any relevant docs pages and docstrings. Docs pages and docstrings should be wrapped at 72 characters.
  • Add an entry in CHANGES.rst. Use the same style as other entries. Also include .. versionchanged:: inline changelogs in relevant docstrings.

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 CacheLib to your GitHub account by clicking the Fork button.

  • Clone the main repository locally.

    $ git clone https://github.com/pallets/cachelib
$ cd cachelib

  • Add your fork as a remote to push your work to. Replace {username} with your username. This names the remote "fork", the default Pallets remote is "origin".

    git remote add fork https://github.com/{username}/cachelib

  • Create a virtualenv.

    .. tabs::

   .. group-tab:: Linux/macOS

      .. code-block:: text

         $ python3 -m venv env
         $ . env/bin/activate

   .. group-tab:: Windows

      .. code-block:: text

         > py -3 -m venv env
         > env\Scripts\activate

  • Upgrade pip and setuptools.

    $ python -m pip install --upgrade pip setuptools

  • Install the development dependencies, then install CacheLib in editable mode.

    $ pip install -r requirements/dev.txt && pip install -e .

  • Install the pre-commit hooks.

    $ pre-commit install

Start coding

  • Create a branch to identify the issue you would like to work on. If you're submitting a bug or documentation fix, branch off of the latest ".x" branch.

    $ git fetch origin
$ git checkout -b your-branch-name origin/main

    If you're submitting a feature addition or change, branch off of the "main" branch.

    $ git fetch origin
$ git checkout -b your-branch-name origin/main

  • Using your favorite editor, make your changes, committing as you go.

  • Include tests that cover any code changes you make. Make sure the test fails without your patch. Run the tests as described below.

  • Push your commits to your fork on GitHub and create a pull request. Link to the issue being addressed with fixes #123 in the pull request.

    $ git push --set-upstream fork your-branch-name

Running the tests

Run the basic test suite with pytest.

$ pytest

This runs the tests for the current environment, which is usually sufficient. CI will run the full suite when you submit your pull request. You can run the full test suite with tox if you don't want to wait.

$ tox

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.

$ pip install coverage
$ coverage run -m pytest
$ coverage html

Open htmlcov/index.html in your browser to explore the report.

Read more about coverage.

Building the docs

Build the docs in the docs directory using Sphinx.

$ cd docs
$ make html

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

Read more about Sphinx.