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 a pull request template #204

Merged
merged 1 commit into from
Sep 28, 2021
Merged

Conversation

fbuys
Copy link
Contributor

@fbuys fbuys commented Sep 3, 2021

Description

With a pull request template, you can customize and standardize the information you'd
like contributors to include when they open a pull requests.

Motivation and Context

Inspired by: https://www.talater.com/open-source-templates/#/page/1

See this link for why we add templates: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates

How Has This Been Tested?

We can only test this by opening up a new PR.
It does not have any affect on the gem itself.

Fixes: #202

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@fbuys fbuys mentioned this pull request Sep 3, 2021
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I suspect we can remove this one, because if the change requires modifying the documentation then they will realize that by reading the next point

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, yes that makes sense 👍

With a pull request template, you can customize and standardize the information you'd
like contributors to include when they open a pull requests.

Inspired by: https://www.talater.com/open-source-templates/#/page/1

See this link for why we add templates: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
@fbuys fbuys force-pushed the 202-github-templates branch from 07162db to 61ae44b Compare September 28, 2021 09:42
@fbuys fbuys requested a review from categulario September 28, 2021 09:42
@dechimp dechimp merged commit 9c13c7a into samg:master Sep 28, 2021
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.

[FEATURE] Add PR template
3 participants