Skip to content

Commit c55316d

Browse files
committed
github: update issue and PR template
Signed-off-by: Salvatore Mesoraca <[email protected]>
1 parent b424517 commit c55316d

File tree

5 files changed

+24
-7
lines changed

5 files changed

+24
-7
lines changed

.github/ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/1-bug.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
Thanks for wanting to report an issue you've found in valkey-py. Please delete this text and fill in the template below.
2-
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!
1+
<!--
2+
Thanks for reporting an issue you've found in valkey-py.
3+
Please delete this text and fill in the template below.
4+
It is of course not always possible to reduce your code to a
5+
small test case, but it's highly appreciated to have as much
6+
data as possible. Thank you!
7+
-->
38

49
**Version**: What valkey-py and what valkey version is the issue happening on?
510

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!--
2+
Thanks for opening a feature request!
3+
-->
4+
5+
**Description**: Description of your feature request
6+
7+
**Example use cases**: List some possible use cases for this feature

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Security Issues
4+
url: mailto:[email protected]
5+
about: Please report security vulnerabilities here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
### Pull Request check-list
22

3-
_Please make sure to review and check all of these items:_
3+
<!-- Please make sure to review and check all of these items: -->
44

55
- [ ] Do tests and lints pass with this change?
66
- [ ] Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
77
- [ ] Is the new or changed code fully tested?
88
- [ ] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
99
- [ ] Is there an example added to the examples folder (if applicable)?
1010

11-
_NOTE: these things are not required to open a PR and can be done
12-
afterwards / while the PR is open._
11+
<!-- NOTE: these things are not required to open a PR and can be done
12+
afterwards / while the PR is open. -->
1313

1414
### Description of change
1515

16-
_Please provide a description of the change here._
16+
<!-- Please provide a description of the change here. -->

INSTALL

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
Please use
33
python setup.py install
44

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

0 commit comments

Comments
 (0)