Change issue templates to forms #3951
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I'm all for it if we stop getting the placeholder text in the issue description 😅 |
xrmx
reviewed
Jun 5, 2024
emdneto
commented
Jun 5, 2024
xrmx
reviewed
Jun 5, 2024
pmcollins
reviewed
Jun 5, 2024
xrmx
reviewed
Jun 6, 2024
xrmx
approved these changes
Jun 6, 2024
pmcollins
approved these changes
Jun 6, 2024
lzchen
approved these changes
Jun 7, 2024
ocelotl
approved these changes
Jun 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR proposes to transition otel-python issue templates to GitHub's issue forms feature.
I noticed other otel projects are adopting this model, including opentelemetry-js, opentelemetry-rust, opentelemetry-dotnet, otel-operator, otel-collector-contrib.
With forms, we can also maintain consistency across issues, enforce mandatory fields, and allow users to provide logs as a simple copy-paste operation with formatting automatically applied by the respective form. I believe this will simplify the process for new contributors and ensure they provide all the necessary information.
It's just a simple proposal, so I'm also open to any suggestions you have, especially on defining the required fields. In general, I think this will enhance the overall contributor experience and streamline issue management for maintainers. Templates proposed here are based on the ones from otel-rust and otel-js.
This is what it looks like if anyone wants to try