Skip to content

Commit

Permalink
improve PR template
Browse files Browse the repository at this point in the history
Signed-off-by: Anton Kosyakov <anton.kosyakov@typefox.io>
  • Loading branch information
akosyakov committed Jul 1, 2019
1 parent d89a881 commit 8e1f071
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1 +1,31 @@
<!-- Please provide a clear and meaningful description to the CHANGELOG.md file if this PR contributes some significant changes -->
<!--
Thank you for your Pull Request. Please provide a description above and review
the requirements below.
Bug fixes and new features should include tests and possibly benchmarks.
Contributors guide: https://github.com/theia-ide/theia/blob/master/CONTRIBUTING.md
-->

#### What it does
<!-- Include relevant issues and describe how they are addressed -->

#### How to test
<!-- Describe how a reviewer can verify changes within Theia repo -->

#### Review Checklist
<!-- For completed items, change [ ] to [x]. -->
<!-- For inapplicable items, cross out with `[ ] foo` to `[x] ~~foo~~`. -->

- [ ] commits are signed-off: https://github.com/theia-ide/theia/blob/master/CONTRIBUTING.md#sign-your-work
- [ ] commit history is cleaned up of merge and fix up commits
- use `git pull -r` to pick up changes from the master
- [ ] tests/benchmarks are defined for functionallity/perf optimizations and verified by a reviewer, not an author
- [ ] [changelog](https://github.com/theia-ide/theia/blob/master/CHANGELOG.md) is updated
- [ ] breaking changes are justified and recorded in the changelog
- [ ] new dependendencies are justified and [verified](https://github.com/theia-ide/theia/wiki/Registering-CQs#wip---new-ecd-theia-intellectual-property-clearance-approach-experimental)
- [ ] copied code are justified and [approved via a CQ](https://github.com/theia-ide/theia/wiki/Registering-CQs#case-3rd-party-project-code-copiedforked-from-another-project-into-eclipse-theia-maintained-by-us)
- [ ] new code is aligned with [project organization](https://github.com/theia-ide/theia/wiki/Code-Organization) and [coding conventions](https://github.com/theia-ide/theia/wiki/Coding-Guidelines)
- [ ] each review approve is provided with a comment regarding whether functionallity is tested, design or code are aligned with project organization and conventions
- an approve without comment should be dismissed
- a reviewer should focus on requirements and design validation first, testing second and checking code alignment as the last

0 comments on commit 8e1f071

Please sign in to comment.