Skip to content

Commit

Permalink
Merge pull request #1 from tejal29/add_pr_template
Browse files Browse the repository at this point in the history
add github pull request template
  • Loading branch information
tejal29 authored Sep 16, 2019
2 parents 6ea013e + 29fdf2f commit eb5acd2
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 0 deletions.
68 changes: 68 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<!-- 🎉🎉🎉 Thank you for the PR!!! 🎉🎉🎉 -->


Relates to _in case of new feature, this should point to issue/(s) which describes the feature_

Fixes _in case of a bug fix, this should point to a bug and any other related issue(s)_

Should merge before : _list any dependent PRs_

# Description

<!-- Describe your changes here- ideally you can get that description straight from
your descriptive commit message(s)! -->

# Output Changes
Write n/a if not output or log lines added

## Before
Paste skaffold output before your change

## After
Paste skaffold output after your change

## Next PRs.

In this section describe a list of follow up PRs if the current PR is a part of big feature change.

See example #2811

Write n/a if not applicable.


# Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

- [ ] Includes [unit tests](../DEVELOPMENT.md#creating-a-pr)
- [ ] Mentions any output changes.

_See [the contribution guide](../CONTRIBUTING.md) for more details._

Double check this list of stuff that's easy to miss:

- If you are adding [a example to the `examples` dir](../examples), please copy them to [`integration/examples`](../integration/examples)
- Every new example added in [`integration/examples`](../integration/examples) dir should be tested in [integration test](../integration)

## Reviewer Notes

- [ ] The code flow looks good.
- [ ] Unit test added.
- [ ] User facing document changes look good.


# Release Notes

Describe any user facing changes here so maintainer can include it in the release notes, or delete this block.

```
Examples of user facing changes:
- Skaffold config changes like
e.g. "Add buildArgs to `Kustomize` deployer skaffold config."
- Bug fixes
e.g. "Improve skaffold init behaviour when tags are used in manifests"
- Any changes in skaffold behavior
e.g. "Artiface cachine is turned on by default."
```
1 change: 1 addition & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ When you have changes you would like to propose to skaffold, you will need to:
1. Ensure the commit message(s) describe what issue you are fixing and how you are fixing it
(include references to [issue numbers](https://help.github.com/articles/closing-issues-using-keywords/)
if appropriate)
1. Add unit tests. Unit test coverage should increase or stay the same with every PR.
1. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
### Reviews
Expand Down

0 comments on commit eb5acd2

Please sign in to comment.