diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-04-02 14:03:24 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-04-03 15:30:00 -0500 |
| commit | 8854ae6982aeca12349536bcecf16eb0a8973c45 (patch) | |
| tree | ffddc3493ebcf304e26b18735f9f9f281752872f /CONTRIBUTING.md | |
| parent | 494daa1cb0a276c148b9baf05599f9d1baa01c4b (diff) | |
| download | requests-cache-8854ae6982aeca12349536bcecf16eb0a8973c45.tar.gz | |
Improvements to Sphinx documentation:
* Use sphinx-apidoc to auto-generate sources for backend modules
* Still manually adding other modules for more control over formatting
* Add a couple more contributors I missed
* Include contributors on readthedocs
* Add 'all' Makefile target and clean auto-generated docs
* Remove unused build targets in Makefile
* Update interpshinx links that have moved
* Fix some interpshinx links
* Fix some `:ref:` links using auto-generated labels (and some manually added labels where convenient)
* Fix some docstring formatting
* Fix remaining build warnings
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80303fe..8417d97 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,9 +10,13 @@ Maintenance will mainly focus on bugfixes, security and compatibility updates, e If there is a new feature you would like to see, the best way to make that happen is to submit a PR for it! +## Bug Reports & Feedback +If you discover a bug, want to propose new feature, or have other feedback about requests-cache, please +[create an issue](https://github.com/reclosedev/requests-cache/issues/new/choose)! + ## Project Discussion -If you have an issue or PR that hasn't received a response in a timely manner, or if you want to -discuss ideas about the project in general, please reach out on the Code Shelter chat server, under +If you want to discuss ideas about the project in general, or if you have an issue or PR that hasn't +received a response in a timely manner, please reach out on the Code Shelter chat server, under [projects/requests-cache](https://codeshelter.zulipchat.com/#narrow/stream/186993-projects/topic/requests-cache). ## Dev Installation @@ -67,7 +71,7 @@ pytest tests/integration ## Debugging When you run into issues while working on new features and/or tests, it will make your life much easier -to use a debugger instead of haphazard `print` statements. Most IDEs have a built-in debugger, but if +to use a debugger instead of `print` statements. Most IDEs have a built-in debugger, but if you prefer the command line, [ipdb](https://github.com/gotcha/ipdb) is a good option. To install: ```bash pip install ipython ipdb @@ -80,7 +84,7 @@ The `runtests.sh` script will use ipdb by default, if it's installed. To build the docs locally: ```bash -$ make -C docs html +$ make -C docs all ``` To preview: |