From 59665d6ef22c44570aa1a7623feaf607cf8e56a8 Mon Sep 17 00:00:00 2001 From: "Chayim I. Kirshen" Date: Tue, 23 Nov 2021 15:46:59 +0200 Subject: Updating PR template --- .github/PULL_REQUEST_TEMPLATE.md | 1 + examples/README.md | 3 +++ 2 files changed, 4 insertions(+) create mode 100644 examples/README.md 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). -- cgit v1.2.1