summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChayim I. Kirshen <c@kirshen.com>2021-11-23 15:46:59 +0200
committerChayim I. Kirshen <c@kirshen.com>2021-11-23 15:46:59 +0200
commit59665d6ef22c44570aa1a7623feaf607cf8e56a8 (patch)
tree89f466b08b0e00c922159e4fbd92c7a7ec9fcac0
parent64791a54f4b2c28b6a61920a23df9e1f614e6983 (diff)
downloadredis-py-ck-template.tar.gz
Updating PR templateck-template
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md1
-rw-r--r--examples/README.md3
2 files changed, 4 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 2bbc804..58062a1 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,6 +6,7 @@ _Please make sure to review and check all of these items:_
- [ ] Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
- [ ] Is the new or changed code fully tested?
- [ ] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
+- [ ] Is there an example added to the examples folder (if applicable)?
_NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open._
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..ca6d5dc
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,3 @@
+# Examples
+
+Examples of redis-py usage go here. They're being linked to the [generated documentation](https://redis-py.readthedocs.org).