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

Add Issue templates and automation scripts #777

Merged

Conversation

joaopgrassi
Copy link
Member

@joaopgrassi joaopgrassi commented Feb 27, 2024

Fixes #773

Changes

This PR adds several automations/improvements related to issue triage/project management and a bit of dev experience for users.

The main things added are:

  • Introduce concept of area - Those are the names of the yaml files inside model/registry
  • Issue templates, that contain a drop-down for the area.
  • Scripts and actions to automate the process of:
    • Assigning the correct area label for new issues
    • Creating new labels when new areas are merged into the registry
    • Check when new areas are introduced in PRs, so the issue templates are always up-to-date (see example here)

As a follow up, we can: (out of scope of this PR)

  • Improve the CONTRIBUTING.md to add the definition of the labels and talk about the issue templates a bit
  • Check if we can use the new area concept and assign those to our GitHub teams, so issues are assigned to the proper responsible party, instead of always maintainers

This work is based on what the folks over on the collector contrib repo have. (Thanks @evan-bradley!)

You can check how this looks like now in this test repository https://github.com/joaopgrassi/test-actions-otel. Feel free to create issues to test, or create PRs to verify the checks.

@joaopgrassi joaopgrassi requested review from a team February 27, 2024 16:40
@joaopgrassi joaopgrassi added the Skip Changelog Label to skip the changelog check label Feb 27, 2024
trask pushed a commit to trask/semantic-conventions that referenced this pull request Feb 27, 2024
* Consistency between Span and Resource attributes

* Address feedback

* Wording
trask pushed a commit to trask/semantic-conventions that referenced this pull request Feb 27, 2024
* Consistency between Span and Resource attributes

* Address feedback

* Wording
@pyohannes
Copy link
Contributor

Given the fact that we now tag all new issues with triage:needs-triage, do you think it still makes sense to auto-assign issues to maintainers? It seems the auto-assignment to maintainers burdens them and didn't have the desired effect in the past.

For doing project management for messaging, I prefer to assign issues to folks who are actually working on it, and keep issues unassigned when nobody is working on it.

@joaopgrassi
Copy link
Member Author

Given the fact that we now tag all new issues with triage:needs-triage, do you think it still makes sense to auto-assign issues to maintainers? It seems the auto-assignment to maintainers burdens them and didn't have the desired effect in the past.

@pyohannes Yes, that is true. In the linked issue I mentioned handling this as a follow up:

Follow ups after this initial work

Set up the owners/team based on area
Based on the area automatically assign the issue to the respective owner/team
More in depth definition of issue triage/from open to done, like as suggested in 

open-telemetry/opentelemetry-specification#3821

We can debate whether to leave it unassigned or assign to the proper owners/team, like they do in the collector repos.

@pyohannes
Copy link
Contributor

We can debate whether to leave it unassigned or assign to the proper owners/team, like they do in the collector repos.

I'd be in favor of having it unassigned, the area:* and needs-triage labels should be enough to get the right people to look at it, but assigning it to proper owners for the given area should be fine too if that's preferred by others.

@joaopgrassi joaopgrassi merged commit 4f25eb5 into open-telemetry:main Mar 19, 2024
11 checks passed
@joaopgrassi joaopgrassi deleted the feat/issue-templates branch March 19, 2024 10:21
ChrsMark pushed a commit to ChrsMark/semantic-conventions that referenced this pull request Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog Label to skip the changelog check
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Improve development experience/triage process
5 participants