mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2026-02-10 07:00:54 +00:00
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.
|
|
||||||
70
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
70
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,70 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: File a bug report
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## What was wrong"
|
||||||
|
- type: textarea
|
||||||
|
id: what-happened
|
||||||
|
attributes:
|
||||||
|
label: What happened?
|
||||||
|
description: Also tell us what you expected to happen
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: code-that-caused
|
||||||
|
attributes:
|
||||||
|
label: Code that produced the error
|
||||||
|
description: Formats to Python, no backticks needed
|
||||||
|
render: python
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: error-output
|
||||||
|
attributes:
|
||||||
|
label: Full error output
|
||||||
|
description: Formats to shell, no backticks needed
|
||||||
|
render: shell
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Potential Solutions"
|
||||||
|
- type: textarea
|
||||||
|
id: how-to-fix
|
||||||
|
attributes:
|
||||||
|
label: Fill this section in if you know how this could or should be fixed
|
||||||
|
description: Include any relevant examples or reference material
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: lib-version
|
||||||
|
attributes:
|
||||||
|
label: <PYPI_NAME> Version
|
||||||
|
description: Which version of <PYPI_NAME> are you using?
|
||||||
|
placeholder: x.x.x
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: py-version
|
||||||
|
attributes:
|
||||||
|
label: Python Version
|
||||||
|
description: Which version of Python are you using?
|
||||||
|
placeholder: x.x.x
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: Operating System
|
||||||
|
description: Which operating system are you using?
|
||||||
|
placeholder: osx/linux/win
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: pip-freeze
|
||||||
|
attributes:
|
||||||
|
label: Output from pip-freeze
|
||||||
|
description: Run `pip-freeze` and paste the output below
|
||||||
|
render: shell
|
||||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Questions about using <REPO_NAME>?
|
||||||
|
url: https://discord.gg/GHryRvPB84
|
||||||
|
about: You can ask and answer usage questions on the Ethereum Python Community Discord
|
||||||
11
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
name: Feature Request
|
||||||
|
description: Request a new feature
|
||||||
|
labels: ["feature_request"]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: feature-description
|
||||||
|
attributes:
|
||||||
|
label: What feature should we add?
|
||||||
|
description: Include any relevant examples or reference material
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
17
.github/PULL_REQUEST_TEMPLATE.md
vendored
17
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,17 +0,0 @@
|
|||||||
### What was wrong?
|
|
||||||
|
|
||||||
Related to issue #
|
|
||||||
|
|
||||||
### How was it fixed?
|
|
||||||
|
|
||||||
### To-Do
|
|
||||||
|
|
||||||
[//]: # (Stay ahead of things, add list items here!)
|
|
||||||
- [ ] Clean up commit history
|
|
||||||
|
|
||||||
[//]: # (See: https://<RTD_NAME>.readthedocs.io/en/latest/contributing.html#pull-requests)
|
|
||||||
- [ ] Add entry to the [release notes](https://github.com/ethereum/<REPO_NAME>/blob/master/newsfragments/README.md)
|
|
||||||
|
|
||||||
#### Cute Animal Picture
|
|
||||||
|
|
||||||
![put a cute animal picture link inside the parentheses]()
|
|
||||||
17
.github/pull_request_template.md
vendored
Normal file
17
.github/pull_request_template.md
vendored
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
### What was wrong?
|
||||||
|
|
||||||
|
Related to Issue #
|
||||||
|
Closes Issue #
|
||||||
|
|
||||||
|
### How was it fixed?
|
||||||
|
|
||||||
|
### Todo:
|
||||||
|
- [ ] Clean up commit history
|
||||||
|
|
||||||
|
- [ ] Add or update documentation related to these changes
|
||||||
|
|
||||||
|
- [ ] Add entry to the [release notes](https://github.com/ethereum/web3.py/blob/master/newsfragments/README.md)
|
||||||
|
|
||||||
|
#### Cute Animal Picture
|
||||||
|
|
||||||
|
![Put a link to a cute animal picture inside the parenthesis-->]()
|
||||||
Reference in New Issue
Block a user