Proposal: Add templates for Issues and PRs #2611
Conversation
| @@ -0,0 +1,22 @@ | |||
| --- | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
👍 Let's keep it and see how often it is used.
|
|
||
| <!-- For questions please use the rust-libp2p GitHub Discussions forum.--> | ||
|
|
||
| <!-- For security related issues please reach out to security@ipfs.io. Please do not file a public issue on GitHub. --> |
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
|
|
||
| <!-- Thank you for filing a bug report! --> | ||
|
|
||
| <!-- For questions please use the rust-libp2p GitHub Discussions forum.--> |
There was a problem hiding this comment.
Could this be linked like discuss.libp2p.io in config.yaml?
| --- | ||
|
|
||
| <!-- | ||
| 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/libp2p instead. Even better, create a new topic on the forums (https://discuss.libp2p.io). |
There was a problem hiding this comment.
| 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/libp2p instead. Even better, create a new topic on the forums (https://discuss.libp2p.io). | |
| 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. |
Is anyone still using libp2p/libp2p?
I would suggest we keep discuss.libp2p.io for helping folks. I would prefer any design work to happen on libp2p/specs.
There was a problem hiding this comment.
I copied that part from the go-libp2p template: https://github.com/libp2p/go-libp2p/blob/e8d3df92f7a6f72475dcd028496be2c6923fcb3a/.github/ISSUE_TEMPLATE/feature.md?plain=1#L8 (cc @marten-seemann).
But keeping design work to a single place, that is libp2p/specs, sounds good to me.
|
|
||
| ## 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.--> |
There was a problem hiding this comment.
This is cool! I like emphasizing the fact that this project is open to external contributions.
Co-authored-by: Max Inden <mail@max-inden.de>
|
Somehow, the contact links are not shown when creating a new issue. I tested the same config in a dummy repo, but there it works as expected: https://github.com/elenaf9/test/issues/new/choose. I don't know why this is the case, is this something that could be suppressed by certain Repo settings? |
|
Maybe @galargh knows more? Is this related to the libp2p Github organization? |
|
Oh, found the issue. I missed a typo: it should be |
This PR drafts a couple of templates for issues and pull-requests. I think these templates would help debugging reported bugs, and ease the reviews (e.g. not having to ask for a Changelog entry every single time 😄).
The templates are mostly copied from what I saw in other projects. I tried to keep them rather short but include all relevant sections. Happy to add more cases or drop individual templates. Also grateful for any suggestions for improvement of the proposed templates.
In case that anybody is opposed to adding templates I am happy to discuss it.