mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
chore(cfg): update new issue templates
Signed-off-by: Dave Huseby <dwh@linuxprogrammer.org>
This commit is contained in:
committed by
Paul Robinson
parent
b973caa484
commit
8bb1647d2c
38
.github/ISSUE_TEMPLATE.md
vendored
38
.github/ISSUE_TEMPLATE.md
vendored
@ -1,38 +0,0 @@
|
||||
_If this is a bug report, please fill in the following sections.
|
||||
If this is a feature request, delete and describe what you would like with examples._
|
||||
|
||||
## What was wrong?
|
||||
|
||||
### Code that produced the error
|
||||
|
||||
```py
|
||||
CODE_TO_REPRODUCE
|
||||
```
|
||||
|
||||
### Full error output
|
||||
|
||||
```sh
|
||||
ERROR_HERE
|
||||
```
|
||||
|
||||
### Expected Result
|
||||
|
||||
_This section may be deleted if the expectation is "don't crash"._
|
||||
|
||||
```sh
|
||||
EXPECTED_RESULT
|
||||
```
|
||||
|
||||
### Environment
|
||||
|
||||
```sh
|
||||
# run this:
|
||||
$ python -m eth_utils
|
||||
|
||||
# then copy the output here:
|
||||
OUTPUT_HERE
|
||||
```
|
||||
|
||||
## How can it be fixed?
|
||||
|
||||
Fill this section in if you know how this could or should be fixed.
|
||||
56
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
56
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,56 @@
|
||||
name: Bug Report
|
||||
description: Create a bug report for py-libp2p
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for filing a bug report!
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Summary
|
||||
description: Please provide a short summary of the bug, along with any information you feel relevant to replicate the bug.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: Describe what you expect to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
description: Describe what actually happens.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Relevant log output
|
||||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Possible Solution
|
||||
description: Suggest a fix/reason for the bug, or ideas how to implement the addition or change.
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Run this: `$ python -m eth_utils` and put the results here.
|
||||
render: shell
|
||||
validations:
|
||||
required: false
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Would you like to work on fixing this bug ?
|
||||
description: Any contribution towards fixing the bug is greatly appreciated. We are more than happy to provide help on the process.
|
||||
options:
|
||||
- "Yes"
|
||||
- "No"
|
||||
- Maybe
|
||||
validations:
|
||||
required: true
|
||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Technical Questions
|
||||
url: https://github.com/libp2p/py-libp2p/discussions/new?category=q-a
|
||||
about: Please ask technical questions in the py-libp2p Github Discussions forum.
|
||||
- name: Community-wide libp2p Discussion
|
||||
url: https://discuss.libp2p.io
|
||||
about: Discussions and questions about the libp2p community.
|
||||
31
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
Normal file
31
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
name: Enhancement
|
||||
description: Suggest an improvement to an existing py-libp2p feature.
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: Describe the enhancement that you are proposing.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Motivation
|
||||
description: Explain why this enhancement is beneficial.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Current Implementation
|
||||
description: Describe the current implementation.
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Are you planning to do it yourself in a pull request ?
|
||||
description: Any contribution is greatly appreciated. We are more than happy to provide help on the process.
|
||||
options:
|
||||
- "Yes"
|
||||
- "No"
|
||||
- Maybe
|
||||
validations:
|
||||
required: true
|
||||
42
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
42
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,42 @@
|
||||
name: Feature request
|
||||
description: Suggest a new feature in py-libp2p
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
If you'd like to suggest a feature related to libp2p but not specifically related to the python implementation, please file an issue at https://github.com/libp2p/specs instead.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: Briefly describe the feature that you are requesting.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Motivation
|
||||
description: Explain why this feature is needed.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Requirements
|
||||
description: Write a list of what you want this feature to do.
|
||||
placeholder: "1."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Open questions
|
||||
description: Use this section to ask any questions that are related to the feature.
|
||||
validations:
|
||||
required: false
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Are you planning to do it yourself in a pull request ?
|
||||
description: Any contribution is greatly appreciated. We are more than happy to provide help on the process.
|
||||
options:
|
||||
- "Yes"
|
||||
- "No"
|
||||
- Maybe
|
||||
validations:
|
||||
required: true
|
||||
Reference in New Issue
Block a user