search

Github-Community-Standards / github-community-standards

Checks the community standards of your project when you open the repo
MIT License
8 stars 2 forks source link

[ADD] PULL_REQUEST_TEMPLATE #11

Closed homiecoder closed 1 year ago

homiecoder commented 1 year ago

create a .github/PULL_REQUEST_TEMPLATE containing the pull request template.

The template can be markdown with some simple and reasonable things.

Examples (1 of 2):

<!-- Thanks for sending a pull request! Please make sure you click the link above to view the
contribution guidelines, then fill out the blanks below. -->

What does this implement/fix? Explain your changes.
---------------------------------------------------
…

Does this close any currently open issues?
------------------------------------------
…

Any relevant logs, error output, etc?
-------------------------------------
<!-- If it’s long, please paste to https://gist.github.com/ and insert the link here. -->

Any other comments?
-------------------
…

Where has this been tested?
---------------------------
**Operating System:** …

**Platform:** …

**Target Platform:** …

**Toolchain Version:** …

**SDK Version:** …

Examples (2 of 2):

## Proposed changes

Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.

## Types of changes

What types of changes does your code introduce to github-community-standards?
_Put an `x` in the boxes that apply_

- [ ] Bugfix (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 not work as expected)
- [ ] Documentation Update (if none of the other choices apply)

## Checklist

_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._

- [ ] I have read the [CONTRIBUTING](https://github.com/github-community-standards/blob/master/CONTRIBUTING.md) doc
- [ ] I have signed the CLA
- [ ] Lint and unit tests pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)
- [ ] Any dependent changes have been merged and published in downstream modules

## Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
homiecoder commented 1 year ago

Gonna work on this one.

kjaymiller commented 1 year ago

This is great but there is a lot in both of these templates we don't need.

If you can add the first half of the first templates

<!-- Thanks for sending a pull request! Please make sure you click the link above to view the
contribution guidelines, then fill out the blanks below. -->

What does this implement/fix? Explain your changes.
---------------------------------------------------
…

Does this close any currently open issues?
------------------------------------------
…

Any relevant logs, error output, etc?
-------------------------------------
<!-- If it’s long, please paste to https://gist.github.com/ and insert the link here. -->

Any other comments?
-------------------
…
homiecoder commented 1 year ago

Ok, let me know if you thinks this fits better. I added a couple extra things that may help us noobs.

-hc