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

Update PR Template to Include New Description/Overview Guidelines #11

Merged
merged 4 commits into from
Oct 19, 2023

Conversation

ShaunaGordon
Copy link
Contributor

Stakeholder Overview

We're in the process of improving the PR template to not only be more useful in writing PRs, but also in reading them. In the future, this will allow us to use them as the basis for automated deployment notifications, changelog aggregation, and other archival and communication purposes.

Changes

  • Change "description" to "Stakeholder Overview" to make section purpose more explicit and self-documenting
  • Add more elaborate helper notes to encourage more desired descriptions

### Stakeholder Overview

We're in the process of improving the PR template to not only be more useful in writing PRs, but also in reading them. In the future, this will allow us to use them as the basis for automated deployment notifications, changelog aggregation, and other archival and communication purposes.
Copy link
Member

@chmurph2 chmurph2 left a comment

Choose a reason for hiding this comment

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

LGTM, fixed some typos. The "good examples" seem good. 🙂

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
Copy link
Contributor

@invacuo invacuo left a comment

Choose a reason for hiding this comment

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

Just left some InkGPT suggestions to make it more concise. Totally fine if you prefer to leave it as it is too. Thanks for taking ownership and pushing this forward 👏

.github/pull_request_template.md Outdated Show resolved Hide resolved
Copy link

@kgillison kgillison left a comment

Choose a reason for hiding this comment

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

I like it ❤️

ShaunaGordon and others added 3 commits October 19, 2023 12:44
@ShaunaGordon ShaunaGordon merged commit 5cbaf6c into master Oct 19, 2023
@ShaunaGordon ShaunaGordon deleted the sg/update-description branch October 19, 2023 17:06
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.

4 participants