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 PULL_REQUEST_TEMPLATE.md #125

Merged
merged 2 commits into from
May 3, 2019
Merged

Conversation

ttannis
Copy link
Contributor

@ttannis ttannis commented May 2, 2019

Summary of Changes

This PR updates the pull request template to highlight information about the PR and condense the checkpoints into a single checklist. As a reviewer I find PRs easier to review if all of the relevant content is placed together at the beginning. As a contributor I find PRs easier to submit if the checked items are condensed into one single checklist.

Copy-pasting the new template into this PR description to demo.

Tests

No tests were added -- this PR only updates the PR template and does not touch source code.

Documentation

Updated PULL_REQUEST_TEMPLATE.md

CheckList

Make sure you have checked all steps below to ensure a timely review.

  • PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
  • PR includes a summary of changes, including screenshots of any UI changes.
  • PR adds unit tests, updates existing unit tests, OR documents why no test additions or modifications are needed.
  • In case of new APIs, my PR adds documentation that describes how to use it.
    • All the public python functions and the classes in the PR contain docstrings that explain what it does
  • PR passes all tests documented in the developer guide
  • I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message"

@ttannis
Copy link
Contributor Author

ttannis commented May 2, 2019

cc @verdan I've reorganized the PR template a bit to condense it into 3 main sections + the final checklist.

@ttannis ttannis merged commit f144eae into master May 3, 2019
@ttannis ttannis deleted the ttannis-update-pr-template branch May 3, 2019 00:30
@verdan
Copy link
Member

verdan commented May 3, 2019

Sweet !! I like that. Could you please update that in all other repos?
@ttannis

@ttannis
Copy link
Contributor Author

ttannis commented May 3, 2019

Sweet !! I like that. Could you please update that in all other repos?
@ttannis

Sure thing. cc @feng-tao @jinhyukchang I'll be updating the PR templates for other repos when I have some spare time.

ttannis added a commit to amundsen-io/amundsensearchlibrary that referenced this pull request May 7, 2019
### Summary of Changes

This PR consolidates the pull request template initially added by @verdan. It's been requested to be updated across all of our repos: amundsen-io/amundsenfrontendlibrary#125 (comment)

### Tests

Unit tests not required for template changes.

### Documentation

Documentation not required for template changes.

### CheckList
Make sure you have checked **all** steps below to ensure a timely review.
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
    - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
- [ ] PR includes a summary of changes. 
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed.
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
    - All the public functions and the classes in the PR contain docstrings that explain what it does
- [ ] PR passes `make test`
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
ttannis added a commit to amundsen-io/amundsensearchlibrary that referenced this pull request May 7, 2019
### Summary of Changes

This PR consolidates the pull request template initially added by @verdan. It's been requested to be updated across all of our repos: amundsen-io/amundsenfrontendlibrary#125 (comment)

### Tests

Unit tests not required for template changes.

### Documentation

Documentation not required for template changes.

### CheckList
Make sure you have checked **all** steps below to ensure a timely review.
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
    - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
- [ ] PR includes a summary of changes. 
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed.
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
    - All the public functions and the classes in the PR contain docstrings that explain what it does
- [ ] PR passes `make test`
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
dorianj pushed a commit to dorianj/amundsen that referenced this pull request Apr 25, 2021
### Summary of Changes

This PR consolidates the pull request template initially added by @verdan. It's been requested to be updated across all of our repos: amundsen-io/amundsenfrontendlibrary#125 (comment)

### Tests

Unit tests not required for template changes.

### Documentation

Documentation not required for template changes.

### CheckList
Make sure you have checked **all** steps below to ensure a timely review.
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
    - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
- [ ] PR includes a summary of changes. 
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed.
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
    - All the public functions and the classes in the PR contain docstrings that explain what it does
- [ ] PR passes `make test`
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
feng-tao pushed a commit to amundsen-io/amundsen that referenced this pull request May 7, 2021
### Summary of Changes

This PR consolidates the pull request template initially added by @verdan. It's been requested to be updated across all of our repos: amundsen-io/amundsenfrontendlibrary#125 (comment)

### Tests

Unit tests not required for template changes.

### Documentation

Documentation not required for template changes.

### CheckList
Make sure you have checked **all** steps below to ensure a timely review.
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
    - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
- [ ] PR includes a summary of changes. 
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed.
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
    - All the public functions and the classes in the PR contain docstrings that explain what it does
- [ ] PR passes `make test`
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
zacr pushed a commit to SaltIO/amundsen that referenced this pull request May 13, 2022
### Summary of Changes

This PR consolidates the pull request template initially added by @verdan. It's been requested to be updated across all of our repos: amundsen-io/amundsenfrontendlibrary#125 (comment)

### Tests

Unit tests not required for template changes.

### Documentation

Documentation not required for template changes.

### CheckList
Make sure you have checked **all** steps below to ensure a timely review.
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
    - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
- [ ] PR includes a summary of changes. 
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed.
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
    - All the public functions and the classes in the PR contain docstrings that explain what it does
- [ ] PR passes `make test`
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
hansadriaans pushed a commit to DataChefHQ/amundsen that referenced this pull request Jun 30, 2022
### Summary of Changes

This PR consolidates the pull request template initially added by @verdan. It's been requested to be updated across all of our repos: amundsen-io/amundsenfrontendlibrary#125 (comment)

### Tests

Unit tests not required for template changes.

### Documentation

Documentation not required for template changes.

### CheckList
Make sure you have checked **all** steps below to ensure a timely review.
- [ ] PR title addresses the issue accurately and concisely. Example: "Updates the version of Flask to v1.0.2"
    - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
- [ ] PR includes a summary of changes. 
- [ ] PR adds unit tests, updates existing unit tests, __OR__ documents why no test additions or modifications are needed.
- [ ] In case of new functionality, my PR adds documentation that describes how to use it.
    - All the public functions and the classes in the PR contain docstrings that explain what it does
- [ ] PR passes `make test`
- [ ] I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
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.

3 participants