Skip to content

Commit 0938638

Browse files
authored
.github/: Add templates for Issues and PRs (#2611)
1 parent a1f3547 commit 0938638

File tree

5 files changed

+137
-0
lines changed

5 files changed

+137
-0
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Bug Report
3+
about: Create a bug report for rust-libp2p.
4+
---
5+
6+
<!-- Thank you for filing a bug report! -->
7+
8+
<!-- For security related issues please reach out to [email protected]. Please do not file a public issue on GitHub. -->
9+
10+
## Summary
11+
12+
<!--
13+
Please provide a short summary of the bug, along with any information you feel relevant to replicate the bug.
14+
-->
15+
16+
## Expected behaviour
17+
18+
<!-- Describe what you expect to happen.-->
19+
20+
## Actual behaviour
21+
22+
<!-- Describe what actually happens.-->
23+
24+
<!--
25+
Include debug output in the code block by setting `RUST_LOG=debug` in your environment.
26+
-->
27+
<details><summary>Debug Output</summary>
28+
<p>
29+
30+
```
31+
<output>
32+
```
33+
</p>
34+
</details>
35+
36+
## Possible Solution
37+
<!--- Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change. -->
38+
39+
## Version
40+
<!--
41+
Which version of libp2p are you using?
42+
-->
43+
44+
- libp2p version (version number, commit, or branch):
45+
46+
47+
## Would you like to work on fixing this bug?
48+
49+
<!--Any contribution towards fixing the bug is greatly appreciated.
50+
We are more than happy to provide help on the process.-->
51+
52+
Yes / No / Maybe.

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Question
4+
url: https://github.com/libp2p/rust-libp2p/discussions/new?category=q-a
5+
about: Please ask questions in the rust-libp2p GitHub Discussions forum.
6+
- name: Libp2p Discourse Forum
7+
url: https://discuss.libp2p.io
8+
about: Discussions and questions related to multiple libp2p implementations.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Enhancement
3+
about: Suggest an improvement to an existing rust-libp2p feature.
4+
---
5+
6+
## Description
7+
8+
<!-- Describe the enhancement that you are proposing.-->
9+
10+
## Motivation
11+
12+
<!-- Explain why this enhancement is beneficial.-->
13+
14+
## Current Implementation
15+
16+
<!-- Describe the current implementation. -->
17+
18+
## Are you planning to do it yourself in a pull request?
19+
20+
<!--Any contribution is greatly appreciated. We are more than happy to provide help on the process.-->
21+
22+
Yes / No / Maybe.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature in rust-libp2p.
4+
---
5+
6+
<!--
7+
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.
8+
-->
9+
10+
## Description
11+
12+
<!-- Briefly describe the feature that you are requesting.-->
13+
14+
## Motivation
15+
16+
<!-- Explain why this feature is needed.-->
17+
18+
## Requirements
19+
20+
<!-- Write a list of what you want this feature to do.-->
21+
22+
1.
23+
2.
24+
3.
25+
26+
## Open questions
27+
28+
<!-- Optional: use this section to ask any questions that are related to the feature.-->
29+
30+
## Are you planning to do it yourself in a pull request?
31+
32+
<!--Any contribution is greatly appreciated. We are more than happy to provide help on the process.-->
33+
34+
Yes / No / Maybe.

.github/pull_request_template.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Description
2+
3+
<!-- Please write a summary of your changes and why you made them.-->
4+
5+
## Links to any relevant issues
6+
7+
<!-- Reference any related issues.-->
8+
9+
10+
## Open Questions
11+
12+
<!-- Unresolved questions, if any. -->
13+
14+
## Change checklist
15+
16+
<!-- Please add a Changelog entry in the appropriate crates and bump the crate versions if needed. See <https://github.com/libp2p/rust-libp2p/blob/master/docs/release.md#development-between-releases>-->
17+
18+
- [ ] I have performed a self-review of my own code
19+
- [ ] I have made corresponding changes to the documentation
20+
- [ ] I have added tests that prove my fix is effective or that my feature works
21+
- [ ] A changelog entry has been made in the appropriate crates

0 commit comments

Comments
 (0)