Skip to content

Commit 5dbd73c

Browse files
authored
Added "No review required" note and PR template (#693)
1 parent ab06eb3 commit 5dbd73c

2 files changed

Lines changed: 39 additions & 3 deletions

File tree

.github/pull_request_template.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
3+
You must title your PR like this:
4+
5+
REGION | COHORT_NAME | FIRST_NAME LAST_NAME | PROJ_NAME
6+
7+
For example,
8+
9+
London | May-2025 | Carol Owen | Sprint-1
10+
11+
-->
12+
13+
## Learners, PR Template
14+
<!--
15+
The purpose of the self-checklist is to help ensure the quality and completeness of a PR submission.
16+
17+
You must complete all the tasks in the self-checklist and tick the boxes for those you have finished.
18+
19+
You can tick a box by changing [ ] to [x] (with no spaces inside the brackets).
20+
-->
21+
22+
Self checklist
23+
24+
- [ ] I have titled my PR with REGION | COHORT_NAME | FIRST_NAME LAST_NAME | PROJ_NAME
25+
- [ ] My changes meet the requirements outlined in the `README.md` of this task
26+
27+
## Changelist
28+
29+
<!--
30+
When you submit a PR, you're submitting changes you made to your own copy (fork) of the repository and requesting a review of those changes.
31+
It is best practice to leave a brief description of the changes you have made.
32+
33+
You must replace "Briefly explain your PR." with a brief description of the changes you have made.
34+
-->
35+
Briefly explain your PR.

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,12 @@ To learn more about **pull requests** and how to create one, please use this gui
2626

2727
9. Open a `Pull Request` to this repository
2828

29-
## Finished Work
29+
## How to check your work?
30+
If you have correctly submitted your PR, you can find it in https://github.com/CodeYourFuture/GitHomeworkTest/pulls.
3031

31-
When you've finished you should have a `pull request` that looks like this
32+
Your PR should look like this: https://github.com/CodeYourFuture/GitHomeworkTest/pull/692
3233

33-
https://github.com/CodeYourFuture/GitHomeworkTest/pull/1
34+
**Please note that your PR will not undergo an official review, as none is required.** Most PRs at CodeYourFuture get reviewed, but this one is just for you to practice creating them.
3435

3536
## Asking for Help
3637

0 commit comments

Comments
 (0)