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

chore: update issue templates and codeowners #1993

Merged
merged 9 commits into from
Sep 20, 2024
Merged

Conversation

sofisl
Copy link
Contributor

@sofisl sofisl commented Jul 27, 2024

Hi @googleapis/jsteam-handwritten-libraries!

This PR changes a couple of templates, as requested:

Templates

  1. Updates Bug templates to ask for more specific reproduction. Ask: please review the wording as this will go in your repo, and I'm not sure how much you want to distinguish repo-specific questions from API-specific questions (this seems like it would differ from the monorepo).
  2. Adds a documentation request template for samples/questions on the library. Again, please read and update as necessary.
  3. Feature request templates: Updates to distinguish API-specific FR from library requests.
  4. Asks people to add non-library questions in discussions.
  5. Adds a process request template for repo infra issues.
  6. Codeowners: makes the vertical team the default, with the jsteam as secondary. Moreover, updates yoshi-team to jsteam, since AFAIK that team isn't maintained by twosync and seems really out of date. (You may have to add jsteam as a collaborator on your repo if it isn't already there)
  7. Removing auto-approve use cases as we don't have security exemption to use them. Sorry!

Scripts

  1. Close-invalid-link.cjs: Github is experimenting with .yaml files for templates but hasn't yet included response validation, so this is a hacky way of doing so. This script is fragile and is meant as a stop-gap until GH improves, see. If you make changes to bug template, you may have to update this script because its fragile.
  2. Close-unresponse.cjs && remove-response-label.cjs: These scripts introduce a new functionality. As you're responding to issues and need a response from the OP, add a needs more info label. If the OP does not respond within 15 days, this script will automatically close the issue (does not apply if you don't respond). If the OP does respond, remove-response-label will remove the label so the timer stops.
  3. Accompanying workflows are added for the scripts.

Ask: Much of this was copied over from google-cloud-node with minimal changes since I'm not really sure how API-specific libraries want to handle a lot of this language. Please go through and change the language on the templates (especially) as necessary!

Also, this does not need to hinge on me! Feel free to merge this PR while I'm gone and then merge it into your individual repos. I'll merge any remaining ones once I get back.

If the minority of repos don't want any of these changes at all, you can simply exclude it in your owlbot.py file (feel free to close the PR once it gets to your repo and add these files to be excluded). If the majority of repos don't want these changes, feel free to just close this PR.

@sofisl sofisl requested a review from a team as a code owner July 27, 2024 18:45
synthtool/gcp/templates/node_library/.github/CODEOWNERS Outdated Show resolved Hide resolved
Comment on lines 2 to 5
on:
schedule:
- cron: '30 1 * * *' # Run every day at 01:30
workflow_dispatch:
Copy link
Contributor

Choose a reason for hiding this comment

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

nit, this yaml is a .yml and all of the others are .yamls - request for consistency :)

@sofisl sofisl requested a review from leahecole August 15, 2024 22:34
Comment on lines +2 to +4
name: Question
about: If you have a question, please use Discussions

Copy link
Contributor

Choose a reason for hiding this comment

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

I see that most of the others were changed from markdown -> yaml - should this one be also?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope! It doesn't have any input fields.

Copy link
Contributor

Choose a reason for hiding this comment

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

I could see that, but there might also be some value in just making them consistent for later edits.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

- "NodeDependency"
Copy link
Contributor

Choose a reason for hiding this comment

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

request for yaml not yml to be consistent

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Is it possible we could use .yml for the others above?

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 that's fine too

synthtool/gcp/templates/node_library/.github/CODEOWNERS Outdated Show resolved Hide resolved
@sofisl sofisl requested a review from leahecole August 30, 2024 19:36
Copy link
Contributor

@feywind feywind left a comment

Choose a reason for hiding this comment

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

This is pretty cool, I learned about some GitHub features :)

Just a few advisory comments.

- "NodeDependency"
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it possible we could use .yml for the others above?

Comment on lines +2 to +4
name: Question
about: If you have a question, please use Discussions

Copy link
Contributor

Choose a reason for hiding this comment

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

I could see that, but there might also be some value in just making them consistent for later edits.

state: "closed"
});
}
module.exports = async ({ github, context }) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to change this to {github, context} to match the JS standards elsewhere? I know this is just a tiny one off though...

not been answered for ${numberOfDaysLimit} days. It can be reopened when the \
requested information is provided.`;

module.exports = async ({ github, context }) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment and also I just noticed double quotes, if we do want to do it.

Copy link
Contributor

@leahecole leahecole left a comment

Choose a reason for hiding this comment

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

left a +1 on one of megan's comments but nothing blocking on my end :)

- "NodeDependency"
Copy link
Contributor

Choose a reason for hiding this comment

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

+1 that's fine too

@sofisl sofisl merged commit bf182cd into master Sep 20, 2024
11 checks passed
@sofisl sofisl deleted the addTemplateChanges branch September 20, 2024 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants