search

SE701-T5 / Frontend

This is the frontend repo of Uni-forum, associated with the University of Auckland, SOFTENG701. This repo will be linked to Netlify for ease of deployment and code review
MIT License
1 stars 22 forks source link

Add pull_request_template.md #13

Closed R055A closed 2 years ago

R055A commented 2 years ago

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 #11

Type of change

Checklist:

netlify[bot] commented 2 years ago

✔️ Deploy Preview for uniforum ready!

🔨 Explore the source changes: 5d0a2e46febf620c0029e7b5d6f5100b77b29932

🔍 Inspect the deploy log: https://app.netlify.com/sites/uniforum/deploys/622ef6713b0e3300096d1390

😎 Browse the preview: https://deploy-preview-13--uniforum.netlify.app

yuchendong13 commented 2 years ago

Hi, sorry just want to clarify with these two points:

I don't quite follow what these mean. Do these actions automatically generate a pull request or something?

R055A commented 2 years ago

Hi, sorry just want to clarify with these two points:

* [ ]  Is this pull request head a fork repository?

* [ ]  Is this pull request compare a development branch?

I don't quite follow what these mean. Do these actions automatically generate a pull request or something?

Thank you for the review @yuchendong13

I hope that this answers your question. You will see when making a pull request, but I will make it more descriptive anyway.