Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Add templates for Issues and PRs #2611

Merged
merged 8 commits into from
Apr 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
name: Bug Report
about: Create a bug report for rust-libp2p.
---

<!-- Thank you for filing a bug report! -->

<!-- For security related issues please reach out to security@ipfs.io. Please do not file a public issue on GitHub. -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙏


## 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.
-->
<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.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +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.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would guess that one can reformulate all enhancements as small feature requests. Thus, for the sake of simplicity, we could drop the enhancement template. Not a strong opinion.

Copy link
Contributor Author

@elenaf9 elenaf9 Apr 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about that as well. The reason why I decided to add it is because of issues like #2373, #2484 or #2393, which aren't really (small) features, but instead improvements/ changes in exiting features. Could also rename it to improvement / change / ...?, but enhancement is the common term in other repos.
But not a strong opinion on my side either, I am also okay with removing it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Let's keep it and see how often it is used.

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.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
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.-->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is cool! I like emphasizing the fact that this project is open to external contributions.


Yes / No / Maybe.
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Description

<!-- Please write a summary of your changes and why you made them.-->

## Links to any relevant issues

<!-- Reference any related issues.-->


## Open Questions

<!-- Unresolved questions, if any. -->

## Change checklist

<!-- 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>-->

- [ ] 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 crates