opensearch-project / opensearch-project/.github

[FEATURE] Update github templates to account for documentation updates

Open
#152 4 comments 0 reactions 1 assignee View on GitHub

@Naarcha-AWS is already working on this.

Since Jun 9, 2023.

enhancement
Dominant language
No language data
Stars
41
Forks
74
Avg merge
3d 19h
Merged PRs (30d)
1

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.