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

[FEATURE] Update github templates to account for documentation updates #152

Open
hdhalter opened this issue Mar 29, 2023 · 4 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@hdhalter
Copy link
Contributor

Is your feature request related to a problem?

The current github templates do not prompt the contributor to consider documentation implications.

What solution would you like?

I'd like to add a new field to each of the templates (Issue: Feature Request, Issue: Proposal, and PR), and that prompts an action by the contributor.

What alternatives have you considered?

We have steps in our internal processes to flag a feature for documentation, so we should have a similar flag when a contributor is entering a PR or Issue. This way, we are notified early that a change to documentation is coming, and we can determine scope and assign the appropriate resources.

Do you have any additional context?

For the Issue: Feature Request and Issue: Proposal templates:

Does the feature require updates to the documentation?
If yes, create a documentation issue with the following information: a summary of the proposed update, the target version, all versions that are affected, and other helpful details or links.

For the PR template:

Does the change require updates to the documentation?
If yes, add the “needs-documentation” label and provide the documentation PR link. If a PR doesn’t exist yet, add a link to the documentation issue.

@hdhalter hdhalter added enhancement New feature or request untriaged labels Mar 29, 2023
@Naarcha-AWS
Copy link
Contributor

@hdhalter: I'll go update both templates for you.

@CEHENKLE and @dblock: Once the tweak to both templates is approved, would we need to run a script to make sure that the templates are implemented in the plugin repos?

@dblock
Copy link
Member

dblock commented Apr 3, 2023

@hdhalter: I'll go update both templates for you.

Start with .github and let's make sure those look A-OK.

@CEHENKLE and @dblock: Once the tweak to both templates is approved, would we need to run a script to make sure that the templates are implemented in the plugin repos?

The best way to do this is via meta, https://github.com/opensearch-project/project-meta#make-a-change-in-many-repos. However teams have been customizing templates AFAIK, so I am not sure what's best. We have ~90 repos, this isn't a small feat :( You could meta check-out everything, make changes in a single pass then use scripts/automation to commit/PR. I can help with that offline.

@dblock dblock removed the untriaged label May 11, 2023
@hdhalter
Copy link
Contributor Author

hdhalter commented Jun 8, 2023

Is there an ETA for this?

@dblock
Copy link
Member

dblock commented Jun 9, 2023

@Naarcha-AWS are you still working on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants