From c55316dc6ab3ee6623862e7ee29f7986f5001231 Mon Sep 17 00:00:00 2001 From: Salvatore Mesoraca Date: Wed, 4 Sep 2024 17:29:25 +0200 Subject: [PATCH] github: update issue and PR template Signed-off-by: Salvatore Mesoraca --- .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/1-bug.md} | 9 +++++++-- .github/ISSUE_TEMPLATE/2-feature.md | 7 +++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++++ .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- INSTALL | 2 +- 5 files changed, 24 insertions(+), 7 deletions(-) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/1-bug.md} (51%) create mode 100644 .github/ISSUE_TEMPLATE/2-feature.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/1-bug.md similarity index 51% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/1-bug.md index 5861f19b..dc4313f0 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/1-bug.md @@ -1,5 +1,10 @@ -Thanks for wanting to report an issue you've found in valkey-py. Please delete this text and fill in the template below. -It is of course not always possible to reduce your code to a small test case, but it's highly appreciated to have as much data as possible. Thank you! + **Version**: What valkey-py and what valkey version is the issue happening on? diff --git a/.github/ISSUE_TEMPLATE/2-feature.md b/.github/ISSUE_TEMPLATE/2-feature.md new file mode 100644 index 00000000..dd75bc74 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature.md @@ -0,0 +1,7 @@ + + +**Description**: Description of your feature request + +**Example use cases**: List some possible use cases for this feature diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..94eca7d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Security Issues + url: mailto:security@lists.valkey.io + about: Please report security vulnerabilities here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 66ba87ec..7100f371 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ ### Pull Request check-list -_Please make sure to review and check all of these items:_ + - [ ] Do tests and lints pass with this change? - [ ] Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)? @@ -8,9 +8,9 @@ _Please make sure to review and check all of these items:_ - [ ] 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._ + ### Description of change -_Please provide a description of the change here._ + diff --git a/INSTALL b/INSTALL index 447340ca..c72fbe11 100644 --- a/INSTALL +++ b/INSTALL @@ -2,5 +2,5 @@ Please use python setup.py install -and report errors to Salvatore Mesoraca (salvatore.mesoraca@aiven.io) +and report errors to via https://github.com/valkey-io/valkey-py/issues/new