Skip to content

Commit f6cf126

Browse files
committed
Update repo metadata
1 parent 081d546 commit f6cf126

File tree

4 files changed

+80
-13
lines changed

4 files changed

+80
-13
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ contact_links:
99
- name: CYF Slack
1010
url: codeyourfuture.slack.com
1111
about: Come to #cyf-curriculum and chat
12+
- name: CYF Tech Ed
13+
url: https://github.com/orgs/CodeYourFuture/teams/mentors
14+
about: CYF mentors on Github
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: PD Coursework
2+
description: Assign a piece of PD coursework
3+
title: "[PD] <title>"
4+
labels: [PD, 🏝 Priority Stretch, 🐇 Size Small, 📅 Sprint 1]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to assign this coursework!
10+
- type: input
11+
attributes:
12+
label: Coursework content
13+
validations:
14+
required: true
15+
- type: input
16+
attributes:
17+
label: Estimated time in hours
18+
description: (PD has max 4 per week total)
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: What is the purpose of this assignment?
24+
description: Clearly explain the purpose of this assignment and how trainees can evaluate this.
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: How to submit
30+
description: State in clear steps how a trainee can submit this assignment.
31+
placeholder: |
32+
Copy the Google doc to your own Google Drive
33+
Complete the work assigned
34+
When you are ready, move your document to your class Drive
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: Anything else?
40+
description: |
41+
Links? References? Anything that will give more context
42+
43+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
44+
- type: markdown
45+
attributes:
46+
value: |
47+
**Thank you so much.**
48+
49+
Please now complete this ticket by filling in the options on the sidebar.
50+
51+
1. Update labels
52+
- priority -- is this coursework key, mandatory, or stretch?
53+
- size -- help trainees plan their time with rough estimation
54+
2. Add to project backlog
55+
- add to the project named the same as this repo
56+
- fill in custom fields -- priority, size, hours, week -- to match this issue
57+
58+
Once your ticket is complete, you may like to check it out on the example project board attached to this repo.
59+
This is so you understand how trainees will use your work.

.github/ISSUE_TEMPLATE/coursework.yml renamed to .github/ISSUE_TEMPLATE/tech-ed-assignment.yml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
name: Coursework
2-
description: Assign a piece of coursework
1+
name: Tech Ed Coursework
2+
description: Assign a piece of technical coursework
33
title: "<title>"
4-
labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium, 📅 Module 1]
4+
labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium, 📅 Sprint 1]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thanks for taking the time to assign this coursework!
9+
Thanks for taking the time to assign this coursework!
1010
11-
To support our trainees with planning and prioritising their own learning journey, we want our coursework assignments to be more informative.
11+
To support our trainees with planning and prioritising their own learning journey, we want our coursework assignments to be more informative.
1212
We don't just want to tell them what to do, we want to tell them stuff like:
1313
- why we are doing it
1414
- what it's "for" (problem-solving, debugging, etc)
1515
- how long they should spend on it, maximum
16-
- how to get help
17-
- how to review it with answers
16+
- how to get help
17+
- how to review it with answers
1818
- how to get it reviewed from mentors and peers
1919
- type: input
2020
attributes:
@@ -26,7 +26,7 @@ body:
2626
label: Learning Objectives
2727
description: https://common.codeyourfuture.io/common-theme/shortcodes/objectives/
2828
placeholder: |
29-
<!--{{<objectives}}-->
29+
<!--{{<objectives}}-->
3030
- [ ] CYF format, task list formatting
3131
<!--{{</objectives}}-->
3232
- type: textarea
@@ -38,6 +38,7 @@ body:
3838
- type: input
3939
attributes:
4040
label: Maximum time in hours
41+
description: (Tech has max 16 per week total)
4142
validations:
4243
required: true
4344
- type: textarea
@@ -79,7 +80,7 @@ body:
7980
1. Update labels
8081
- priority -- is this coursework key, mandatory, or stretch? Pick one.
8182
- size -- help trainees plan their time with rough estimation. Pick one
82-
- topics -- add all that seem relevant to you.
83+
- topics -- add all that seem relevant to you.
8384
2. Add a Sprint label to add to the backlog view
8485
- sprint 1,2,3,4
8586

.github/pull_request_template.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
33
You must title your PR like this:
44
5-
REGION | COHORT_NAME | FIRST_NAME LAST_NAME | PROJ_NAME
5+
Region | Cohort | FirstName LastName | Sprint | Assignment Title
66
77
For example,
88
9-
London | March-2025 | Carol Owen | Wireframe
9+
London | 25-ITP-May | Carol Owen | Sprint 1 | Alarm Clock
1010
1111
Complete the task list below this message.
1212
If your PR is rejected, check the task list.
@@ -18,11 +18,15 @@ If your PR is rejected, check the task list.
1818
Self checklist
1919

2020
- [ ] I have committed my files one by one, on purpose, and for a reason
21-
- [ ] I have titled my PR with REGION | COHORT_NAME | FIRST_NAME LAST_NAME | PROJ_NAME
21+
- [ ] I have titled my PR with Region | Cohort | FirstName LastName | Sprint | Assignment Title
2222
- [ ] I have tested my changes
2323
- [ ] My changes follow the [style guide](https://curriculum.codeyourfuture.io/guides/reviewing/style-guide/)
2424
- [ ] My changes meet the [requirements](./README.md) of this task
2525

26+
## Changelist
27+
28+
Briefly explain your PR.
29+
2630
## Questions
2731

28-
Ask any questions you have for your reviewer. Delete this section if there are none.
32+
Ask any questions you have for your reviewer.

0 commit comments

Comments
 (0)