Skip to content

Commit 9360927

Browse files
illicitonionillicitonion
committed
Initial commit
0 parents  commit 9360927

8 files changed

+292
-0
lines changed

‎.github/FUNDING.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
github: CodeYourFuture
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
custom: https://codeyourfuture.io/donate

‎.github/ISSUE_TEMPLATE/config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: CYF
4+
url: [email protected]
5+
about: Please report serious issues here.
6+
- name: Join CYF
7+
url: https://codeyourfuture.io/volunteers/
8+
about: Join CYF here
9+
- name: CYF Slack
10+
url: codeyourfuture.slack.com
11+
about: Come to #cyf-syllabus-tech and chat
12+
- name: CYF Tech Ed
13+
url: https://github.com/orgs/CodeYourFuture/teams/mentors
14+
about: CYF mentors on Github

‎.github/ISSUE_TEMPLATE/pd-assignment.yml

+59
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]
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/tech-ed-assignment.yml

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: Tech Ed Coursework
2+
description: Assign a piece of technical coursework
3+
title: "[TECH ED] <title>"
4+
labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to assign this coursework!
10+
11+
To support our trainees with planning and prioritising their own learning journey, we want our coursework assignments to be more informative.
12+
We don't just want to tell them what to do, we want to tell them stuff like:
13+
- why we are doing it
14+
- what it's "for" (problem-solving, debugging, etc)
15+
- how long they should spend on it, maximum
16+
- how to get help
17+
- how to review it with answers
18+
- how to get it reviewed from mentors and peers
19+
- type: input
20+
attributes:
21+
label: Link to the coursework
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Why are we doing this?
27+
description: Clearly explain the purpose of this assignment
28+
validations:
29+
required: true
30+
- type: input
31+
attributes:
32+
label: Maximum time in hours
33+
description: (Tech has max 16 per week total)
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: How to get help
39+
description: State simply how trainees can get help with this assignment
40+
placeholder: |
41+
Share your blockers in your class channel
42+
https://syllabus.codeyourfuture.io/guides/asking-questions
43+
- type: textarea
44+
attributes:
45+
label: How to submit
46+
description: State in clear steps how a trainee can submit this assignment.
47+
placeholder: |
48+
Fork the repo to your own GitHub account
49+
Make regular small commits with clear messages
50+
When you are ready, open a Pull Request to the CYF repo
51+
Make sure you fill in the PR template provided
52+
validations:
53+
required: true
54+
- type: textarea
55+
attributes:
56+
label: How to review
57+
description: How to get code review and how to self-review
58+
- type: textarea
59+
attributes:
60+
label: Anything else?
61+
description: |
62+
Links? References? Anything that will give more context
63+
64+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
65+
- type: markdown
66+
attributes:
67+
value: |
68+
**Thank you so much.**
69+
70+
Please now complete this ticket by filling in the options on the sidebar.
71+
72+
1. Update labels
73+
- priority -- is this coursework key, mandatory, or stretch? Pick one.
74+
- size -- help trainees plan their time with rough estimation. Pick one
75+
- topics -- add all that seem relevant to you.
76+
2. Add to milestone
77+
- week 1,2,3,4
78+
79+
Once your ticket is complete, you may like to add it to the example project board attached to this repo.
80+
This is so you understand how trainees will use your work. Nobody has built a board copier yet, so trainees will be doing this step themselves.

‎.github/pull_request_template.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
3+
You must title your PR like this:
4+
5+
COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME | WEEK
6+
7+
For example,
8+
9+
NW4 | Carol Owen | HTML-CSS-Module | Week1
10+
11+
Complete the task list below this message.
12+
If your PR is rejected, check the task list.
13+
14+
-->
15+
16+
## Learners, PR Template
17+
18+
Self checklist
19+
20+
- [ ] I have committed my files one by one, on purpose, and for a reason
21+
- [ ] I have titled my PR with COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME | WEEK
22+
- [ ] I have tested my changes
23+
- [ ] My changes follow the [style guide](https://curriculum.codeyourfuture.io/guides/contributing/)
24+
- [ ] My changes meet the [requirements](./README.md) of this task
25+
26+
## Changelist
27+
28+
Briefly explain your PR.
29+
30+
## Questions
31+
32+
Ask any questions you have for your reviewer.

‎HOW_TO_REVIEW.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<!--
2+
Do not edit this file.
3+
Make a change to the template and then pull changes
4+
Repo: https://github.com/CodeYourFuture/Module-Template
5+
-->
6+
7+
# Everyone reviews code at CYF
8+
9+
Mentors and trainees all review code, and collaborate on improving code quality. We are all helping each other to talk, write, and think about code more clearly.
10+
11+
We are not reviewing code as if we were to merge this PR into production; we are opening a technical conversation for the purpose of insight and development.
12+
13+
## Key points:
14+
15+
1. Ask questions instead of making statements:
16+
17+
**YES:** "Is there another element you could use to group a set of fields in a form? Why might someone use a different element in a form?"
18+
**NO:** "Use fieldset not divs"
19+
20+
2. Encourage simplicity, clarity, and precision:
21+
22+
**YES** "There are 15,0000 files in this changelist. Which files should be reviewed?"
23+
**NO** "It doesn't matter; I can try to figure out what you meant."
24+
25+
3. Respect everyone's work and time:
26+
27+
**YES** "I think there's some more to do here. Thanks for sharing where you're up to."
28+
**NO** "This is rubbish. Try harder."
29+
30+
## Labels
31+
32+
Reviewers, please add labels (provided) to the PR once you've reviewed. This helps to focus the trainee on the areas they should work on, and gives an overview for mentors on what the whole cohort needs to work on.
33+
34+
## Solutions
35+
36+
### Where to find solutions?
37+
38+
You can find the solutions for the module on the `solutions` branch.
39+
40+
### Solutions branch
41+
42+
The solutions branch typically contains:
43+
44+
#### Sample solutions
45+
46+
Solutions are example answers not the only correct answers.
47+
48+
#### Common responses guides.
49+
50+
Everyone is invited to contribute commonly encountered problems, mistakes, misunderstandings, and mental-model errors to our common responses documents.
51+
52+
Use these resources to inform your code review, get unstuck, and improve your understanding.
53+
54+
## Guides
55+
56+
Here's a detailed checklist of the sorts of things we should check code for:
57+
58+
https://syllabus.codeyourfuture.io/guides/marking-guide
59+
60+
Here's a detailed style guide to help us all write clear, high quality code:
61+
62+
https://syllabus.codeyourfuture.io/guides/code-style-guide
63+
64+
Here's some help with giving good feedback during code review:
65+
66+
https://teachertraining.codeyourfuture.io/tasks/code-review

‎README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Coursework
2+
3+
Exercises to practice and solidify your understanding of the Tools module of the Software Development Course.

‎contributing.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
Do not edit this file.
3+
Make a change to the template and then pull changes
4+
Repo: https://github.com/CodeYourFuture/Module-Template
5+
-->
6+
7+
# How To Submit Your Coursework
8+
9+
Use Git & Github to submit your coursework as a pull request.
10+
11+
The Github Desktop cheatsheet will help you.
12+
13+
[Github Desktop Cheatsheet](http://syllabus.codeyourfuture.io/git/cheatsheet)
14+
15+
This module will help you submit your coursework.
16+
17+
[Git](http://syllabus.codeyourfuture.io/git/index)
18+
19+
## Questions & Help
20+
21+
Contributing to a remote codebase is a necessary skill for a professional developer. Opening PRs is mandatory at CYF. It is part of the coursework.
22+
23+
If you cannot submit your coursework you **must** post on Slack to get unblocked.
24+
25+
[How to get help](./HOW-TO-GET-HELP.md)

0 commit comments

Comments
 (0)