From b4296e36255c14190e81a5da2d481f942d7d6799 Mon Sep 17 00:00:00 2001 From: elenaf9 Date: Thu, 7 Apr 2022 20:45:53 +0200 Subject: [PATCH 1/7] .github/: Add issue template for bug reports --- .github/ISSUE_TEMPLATE/bug_report.md | 54 ++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..1307a860d2e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,54 @@ +--- +name: Bug Report +about: Create a bug report for rust-libp2p. +--- + + + + + + + +## Summary + + + +## Expected behaviour + + + +## Actual behaviour + + + + +
Debug Output +

+ +``` + +``` +

+
+ +## Possible Solution + + +## Version + + +- libp2p version (version number, commit, or branch): + + +## Would you like to work on fixing this bug? + + + +Yes / No / Maybe. From 1ca089fc3464b2625b3d9c53302c375c1e386693 Mon Sep 17 00:00:00 2001 From: elenaf9 Date: Thu, 7 Apr 2022 23:40:06 +0200 Subject: [PATCH 2/7] .github/: Add issue template for feature requests --- .github/ISSUE_TEMPLATE/feature_request.md | 34 +++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..7213da15545 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,34 @@ +--- +name: Feature request +about: Suggest a new feature in rust-libp2p. +--- + + + +## Description + + + +## Motivation + + + +## Requirements + + + +1. +2. +3. + +## Open questions + + + +## Are you planning to do it yourself in a pull request? + + + +Yes / No / Maybe. From cd2ed3d5d416080c284f8d5224f861a54d30be51 Mon Sep 17 00:00:00 2001 From: elenaf9 Date: Thu, 7 Apr 2022 23:40:12 +0200 Subject: [PATCH 3/7] .github/: Add config.yaml for issues --- .github/ISSUE_TEMPLATE/config.yaml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 00000000000..6ddf07d7745 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Libp2p Discourse Forum + url: https://discuss.libp2p.io + about: Discussions and questions related to multiple libp2p implementations \ No newline at end of file From a186727a038bb29701955f0f396a730e3e74dbe6 Mon Sep 17 00:00:00 2001 From: elenaf9 Date: Thu, 7 Apr 2022 23:40:37 +0200 Subject: [PATCH 4/7] .github/: Add issue template for enhancements --- .github/ISSUE_TEMPLATE/enhancement.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 00000000000..b3a3dd30115 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,22 @@ +--- +name: Enhancement +about: Suggest an improvement to an existing rust-libp2p feature. +--- + +## Description + + + +## Motivation + + + +## Current Implementation + + + +## Are you planning to do it yourself in a pull request? + + + +Yes / No / Maybe. From 98f62db13c0e91b32af981482985b8cd4efe8ba7 Mon Sep 17 00:00:00 2001 From: elenaf9 Date: Thu, 7 Apr 2022 23:57:56 +0200 Subject: [PATCH 5/7] .github/: Add pull-request template --- .github/pull_request_template.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000000..9759c7259c3 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ +# Description + + + +## Links to any relevant issues + + + +## Type of change + + + +- [ ] Bug Fix +- [ ] Enhancement +- [ ] Feature +- [ ] Refactor +- [ ] Documentation Fix +- [ ] Other: + +## Open Questions + + + +## Change checklist + + + +- [ ] I have performed a self-review of my own code +- [ ] I have made corresponding changes to the documentation +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] A changelog entry has been made in the appropriate packages From 7f2b57898e2517499fd2650cc89ced3e96066fc8 Mon Sep 17 00:00:00 2001 From: elenaf9 Date: Sat, 9 Apr 2022 03:22:12 +0200 Subject: [PATCH 6/7] .github/: Link discussions forum for questions --- .github/ISSUE_TEMPLATE/bug_report.md | 2 -- .github/ISSUE_TEMPLATE/config.yaml | 5 ++++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1307a860d2e..36bf6233ef3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -5,8 +5,6 @@ about: Create a bug report for rust-libp2p. - - ## Summary diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml index 6ddf07d7745..a97175d0a26 100644 --- a/.github/ISSUE_TEMPLATE/config.yaml +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -1,5 +1,8 @@ blank_issues_enabled: true contact_links: + - 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. - name: Libp2p Discourse Forum url: https://discuss.libp2p.io - about: Discussions and questions related to multiple libp2p implementations \ No newline at end of file + about: Discussions and questions related to multiple libp2p implementations. \ No newline at end of file From 9fdc688dd4b61464be8915cec22939522c4a869f Mon Sep 17 00:00:00 2001 From: Elena Frank Date: Sat, 9 Apr 2022 03:24:20 +0200 Subject: [PATCH 7/7] .github/: Apply suggestions from review Co-authored-by: Max Inden --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/pull_request_template.md | 14 ++------------ 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 7213da15545..822aa063147 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,7 +4,7 @@ about: Suggest a new feature in rust-libp2p. --- ## Description diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9759c7259c3..7c28e9f668d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,16 +6,6 @@ -## Type of change - - - -- [ ] Bug Fix -- [ ] Enhancement -- [ ] Feature -- [ ] Refactor -- [ ] Documentation Fix -- [ ] Other: ## Open Questions @@ -23,9 +13,9 @@ ## Change checklist - + - [ ] I have performed a self-review of my own code - [ ] I have made corresponding changes to the documentation - [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] A changelog entry has been made in the appropriate packages +- [ ] A changelog entry has been made in the appropriate crates