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 pull_request_template.md #9

Merged
merged 3 commits into from
Mar 14, 2022
Merged

Add pull_request_template.md #9

merged 3 commits into from
Mar 14, 2022

Conversation

R055A
Copy link
Contributor

@R055A R055A commented Mar 13, 2022

Description

A pull request (PR) template added to the ./github directory so contributors can automatically see the expected contents for the project in a new PR body.

The PR template is based on these linked examples provided by @axolo-co but modified to better suit this project.

Template

This is what is seen when editing a new PR:

<!-- Is there a relevant and understandable title succinctly summarizing the changes? -->

# Description

<!--- Give a description of the changes here in more detail -->
<!--- Include screenshots if necessary -->

## Related Issue

<!--- This project only accepts pull requests related to already existing open issues -->
<!--- Please link to the open issue here: -->

Solves #<!--issue-->

<!--Don't forget to move the related issue to the 'Review in progress' column.-->

## Type of change

<!--Please delete options that are not relevant.-->

- [ ] New feature (enhancement)
- [ ] Bug fix
- [ ] Refactor
- [ ] Breaking change
- [ ] Documentation

<!--Don't forget to add a label to the pull request, if relevant.-->

## How Has This Been Tested?

<!--- Please describe in detail how the changes have been tested. -->
<!--- Include details of the testing environment, the tests run, and the results. -->

<!--Please delete options that are not relevant.-->

- [ ] Automated testing
- [ ] Manual testing

# Checklist:

<!--Please delete options that are not relevant.-->

- [ ] Does a similar (open or closed) pull request not already exist?
- [ ] Is the pull request _head_ repository a fork repository?
- [ ] Is the pull request _compare_ branch a development branch?
- [ ] Is the code documented, particularly in hard-to-understand areas?
- [ ] Does the code build without new warnings?
- [ ] Has testing been performed that proves changes are effective and work?
- [ ] Has a self- and/or peer-review of the code been performed?
- [ ] Have dependent changes been merged and published in downstream modules?
- [ ] Does all new and existing automated testing pass?
- [ ] Is the person responsible for the repository assigned to the pull request?
- [ ] Is the pull request linked to a project?
- [ ] Is the pull request linked to a milestone?

For more information, refer to the [Contributing Guidelines](../blob/contribution-guidelines/.github/CONTRIBUTING.md) document.

<!--Don't forget to notify others of the pull request for a quick review.-->

Related Issue

Solves #8

Type of change

  • Documentation

Checklist:

  • Does a similar (open or closed) pull request not already exist?
  • Is the pull request head repository a fork repository?
  • Is the pull request compare branch a development branch?
  • Has a self- and/or peer-review of the code been performed?
  • Does all new and existing automated testing pass?
  • Is the person responsible for the repository assigned to the pull request?
  • Is the pull request linked to a project?
  • Is the pull request linked to a milestone?

@R055A R055A added the documentation Improvements or additions to documentation label Mar 13, 2022
@R055A R055A added this to the Assignment 1 milestone Mar 13, 2022
@R055A R055A self-assigned this Mar 13, 2022
@R055A R055A added this to In progress in Team 5 - Assignment 1 - Backend via automation Mar 13, 2022
@R055A R055A linked an issue Mar 13, 2022 that may be closed by this pull request
AlexMiao7
AlexMiao7 previously approved these changes Mar 13, 2022
Team 5 - Assignment 1 - Backend automation moved this from In progress to Reviewer approved Mar 13, 2022
@R055A R055A requested a review from emettreio March 14, 2022 00:10
hpar461
hpar461 previously approved these changes Mar 14, 2022
hiin3d55
hiin3d55 previously approved these changes Mar 14, 2022
Copy link
Contributor

@hiin3d55 hiin3d55 left a comment

Choose a reason for hiding this comment

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

LGTM!

@R055A R055A dismissed stale reviews from christopher-alba and AlexMiao7 via e7e9303 March 14, 2022 04:20
Team 5 - Assignment 1 - Backend automation moved this from Reviewer approved to In progress Mar 14, 2022
Team 5 - Assignment 1 - Backend automation moved this from In progress to Reviewer approved Mar 14, 2022
Copy link
Contributor

@hiin3d55 hiin3d55 left a comment

Choose a reason for hiding this comment

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

LGTM!

@R055A R055A merged commit cdff653 into SE701-T5:main Mar 14, 2022
Team 5 - Assignment 1 - Backend automation moved this from Reviewer approved to Done Mar 14, 2022
@R055A R055A deleted the pull-request-template branch March 14, 2022 23:18
@qzho236 qzho236 moved this from Done to Reviewer approved in Team 5 - Assignment 1 - Backend Mar 16, 2022
@qzho236 qzho236 moved this from Reviewer approved to Done in Team 5 - Assignment 1 - Backend Mar 16, 2022
@qzho236 qzho236 moved this from Done to Reviewer approved in Team 5 - Assignment 1 - Backend Mar 16, 2022
@R055A R055A moved this from Reviewer approved to Done in Team 5 - Assignment 1 - Backend Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Add pull_request_template.md
7 participants