fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-10 09:57:14 +00:00
Code Issues Projects Releases Wiki Activity

feat: change md issue templates into yml forms

Browse Source 
Resolves: #4151.

Pull-Request: #4560.
This commit is contained in:
clebrin 2023-10-09 10:49:18 +02:00 committed by GitHub
parent 3458950bea
commit 1a460fa66f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 128 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,54 +0,0 @@
---
name: Bug Report
about: Create a bug report for rust-libp2p.
---
<!-- Thank you for filing a bug report! -->
<!-- For security related issues please file a private security vulnerability report at https://github.com/libp2p/rust-libp2p/security/advisories/new or reach out to security@libp2p.io. Please do not file a public issue on GitHub. -->
## Summary
<!--
Please provide a short summary of the bug, along with any information you feel relevant to replicate the bug.
-->
## Expected behaviour
<!-- Describe what you expect to happen.-->
## Actual behaviour
<!-- Describe what actually happens.-->
<!--
Include debug output in the code block by setting `RUST_LOG=debug` in your environment.
Note that for this a logger implementation needs to be initialized in the program, e.g. with
`env_logger::init()`. See <https://docs.rs/log> for more info.
-->
<details><summary>Debug Output</summary>
<p>
```
<output>
```
</p>
</details>
## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change. -->
## Version
<!--
Which version of libp2p are you using?
-->
- libp2p version (version number, commit, or branch):
## Would you like to work on fixing this bug?
<!--Any contribution towards fixing the bug is greatly appreciated.
We are more than happy to provide help on the process.-->
Yes / No / Maybe.

55
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,55 @@
name: Bug Report
description: Create a bug report for rust-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: Version
description: Which version of libp2p are you using? libp2p version (version number, commit, or branch)
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

3
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@ -1,8 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Report a vulnerability
url: https://github.com/libp2p/rust-libp2p/security/advisories/new
about: For security related issues please file a private security vulnerability report.
- name: Question
url: https://github.com/libp2p/rust-libp2p/discussions/new?category=q-a
about: Please ask questions in the rust-libp2p GitHub Discussions forum.

22
.github/ISSUE_TEMPLATE/enhancement.md vendored
View File

@ -1,22 +0,0 @@
---
name: Enhancement
about: Suggest an improvement to an existing rust-libp2p feature.
---
## Description
<!-- Describe the enhancement that you are proposing.-->
## Motivation
<!-- Explain why this enhancement is beneficial.-->
## Current Implementation
<!-- Describe the current implementation. -->
## Are you planning to do it yourself in a pull request?
<!--Any contribution is greatly appreciated. We are more than happy to provide help on the process.-->
Yes / No / Maybe.

31
.github/ISSUE_TEMPLATE/enhancement.yml vendored Normal file
View File

@ -0,0 +1,31 @@
name: Enhancement
description: Suggest an improvement to an existing rust-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

34
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -1,34 +0,0 @@
---
name: Feature request
about: Suggest a new feature in rust-libp2p.
---
<!--
Note: If you'd like to suggest an feature related to libp2p but not specifically related to the rust implementation, please file an issue at https://github.com/libp2p/specs instead.
-->
## Description
<!-- Briefly describe the feature that you are requesting.-->
## Motivation
<!-- Explain why this feature is needed.-->
## Requirements
<!-- Write a list of what you want this feature to do.-->
1.
2.
3.
## Open questions
<!-- Optional: use this section to ask any questions that are related to the feature.-->
## Are you planning to do it yourself in a pull request?
<!--Any contribution is greatly appreciated. We are more than happy to provide help on the process.-->
Yes / No / Maybe.

42
.github/ISSUE_TEMPLATE/feature_request.yml vendored Normal file
View File

@ -0,0 +1,42 @@
name: Feature request
description: Suggest a new feature in rust-libp2p
body:
- type: markdown
attributes:
value: |
If you'd like to suggest a feature related to libp2p but not specifically related to the rust 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