Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

github: update issue and PR template #85

Merged
merged 1 commit into from
Sep 6, 2024
Merged

github: update issue and PR template #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions .github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/1-bug.md
View file
Open in desktop
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 reporting 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
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!--
Thanks for opening a feature request!
-->

**Description**: Description of your feature request
mkmkme marked this conversation as resolved.
Show resolved Hide resolved

**Example use cases**: List some possible use cases for this feature
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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

Loading