-
Notifications
You must be signed in to change notification settings - Fork 107
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add templates for issues and pull requests
- Loading branch information
Showing
4 changed files
with
88 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: "" | ||
labels: bug | ||
assignees: "" | ||
--- | ||
|
||
**Version** | ||
List the versions of all `flood` packages you are using. | ||
|
||
|
||
**Platform** | ||
The output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows) | ||
|
||
**Description** | ||
Enter your issue details here. | ||
One way to structure the description: | ||
|
||
[short summary of the bug] | ||
|
||
I tried this code: | ||
|
||
[code sample that causes the bug] | ||
|
||
I expected to see this happen: [explanation] | ||
|
||
Instead, this happened: [explanation] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: "" | ||
labels: feature-request | ||
assignees: "" | ||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
name: Question | ||
about: Please use the Telegram group for questions | ||
title: "" | ||
labels: "" | ||
assignees: "" | ||
--- | ||
|
||
Please post your question as a discussion in Telegram: https://t.me/paradigm_flood |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
<!-- | ||
Thank you for your Pull Request. Please provide a description above and review | ||
the requirements below. | ||
Bug fixes and new features should include tests. | ||
Contributors guide: https://github.com/paradigmxyz/flood/blob/master/CONTRIBUTING.md | ||
The contributors guide includes instructions for running ruff and building the | ||
documentation. | ||
--> | ||
|
||
## Motivation | ||
|
||
<!-- | ||
Explain the context and why you're making that change. What is the problem | ||
you're trying to solve? In some cases there is not a problem and this can be | ||
thought of as being the motivation for your change. | ||
--> | ||
|
||
## Solution | ||
|
||
<!-- | ||
Summarize the solution and provide any necessary context needed to understand | ||
the code change. | ||
--> | ||
|
||
## PR Checklist | ||
|
||
- [ ] Added Tests | ||
- [ ] Added Documentation | ||
- [ ] Breaking changes |