diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2022-04-11 21:03:50 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2022-04-16 21:08:42 -0500 |
| commit | d6ee9143965d53dae44ca3a98802b2cc7ad6eeb7 (patch) | |
| tree | 96e38c3f7289a0ff3a46c23df3f1e5b3b7c1a940 /CONTRIBUTING.md | |
| parent | 166f5690fb8d5b067f839fa8ffb9421cf1b8a7e7 (diff) | |
| download | requests-cache-d6ee9143965d53dae44ca3a98802b2cc7ad6eeb7.tar.gz | |
Move detailed backend docs from rst docstings to md files
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 1 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ebe626..16988c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,13 +25,6 @@ If you are interested in helping out, here are a few ways to get started: completely ruled out either * If you find an issue you want to work on, please comment on it so others know it's in progress -## Pre-release Installation -If you want to test out the latest in-development changes, you can install pre-release versions: -```bash -pip install --pre requests-cache -``` -Pre-release documentation can be found here: https://requests-cache.readthedocs.io/en/latest/ - ## Dev Installation To set up for local development (requires [poetry](https://python-poetry.org/docs/#installation)): @@ -198,6 +191,7 @@ pip install -U requests-cache Notes: * See python packaging docs on [pre-release versioning](https://packaging.python.org/guides/distributing-packages-using-setuptools/#pre-release-versioning) for more info on how this works +* requests-cache pre-release docs can be found here: https://requests-cache.readthedocs.io/en/latest/ * Any collaborator can trigger a pre-release build for requests-cache by going to **Actions > Deploy > Run workflow** * A complete list of builds can by found on [PyPI under 'Release History'](https://pypi.org/project/requests-cache/#history) |