Skip to content

Commit

Permalink
github: update issue and PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
aiven-sal committed Sep 4, 2024
1 parent b424517 commit bce7acd
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 7 deletions.
9 changes: 7 additions & 2 deletions .github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/1-bug.md
Original file line number Diff line number Diff line change
@@ -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!
<!--
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?

Expand Down
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!--
Thanks for wanting to open a feature request!
-->

**Description**: Description of your feature request
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Security Issues
url: mailto:[email protected]
about: Please report security vulnerabilities here.
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
### Pull Request check-list

_Please make sure to review and check all of these items:_
<!-- 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)?
- [ ] 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._
<!-- 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._
<!-- Please provide a description of the change here. -->
2 changes: 1 addition & 1 deletion INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Please use
python setup.py install

and report errors to Salvatore Mesoraca ([email protected])
and report errors to via https://github.com/valkey-io/valkey-py/issues/new

0 comments on commit bce7acd

Please sign in to comment.