Skip to content

Commit e75587f

Browse files
SallyMcGrathSallyMcGrath
committed
stub new module 1
- simplified work - link to review - lighthouse guide - removed all stretch projects
1 parent 171f53e commit e75587f

17 files changed

Lines changed: 748 additions & 51 deletions

‎.github/ISSUE_TEMPLATE/tech-ed-assignment.yml‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Tech Ed Coursework
22
description: Assign a piece of technical coursework
3-
title: "[TECH ED] <title>"
4-
labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium]
3+
title: "<title>"
4+
labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium, 📅 Module 1]
55
body:
66
- type: markdown
77
attributes:
@@ -21,6 +21,14 @@ body:
2121
label: Link to the coursework
2222
validations:
2323
required: true
24+
- type : textarea
25+
attributes:
26+
label: Learning Objectives
27+
description: https://common.codeyourfuture.io/common-theme/shortcodes/objectives/
28+
placeholder:
29+
<!--{{<objectives}}-->
30+
- [ ] CYF format, task list formatting
31+
<!--{{</objectives}}-->
2432
- type: textarea
2533
attributes:
2634
label: Why are we doing this?
@@ -37,14 +45,14 @@ body:
3745
attributes:
3846
label: How to get help
3947
description: State simply how trainees can get help with this assignment
40-
placeholder: |
48+
value: |
4149
Share your blockers in your class channel
42-
https://syllabus.codeyourfuture.io/guides/asking-questions
50+
https://curriculum.codeyourfuture.io/guides/getting-help/asking-questions/
4351
- type: textarea
4452
attributes:
4553
label: How to submit
4654
description: State in clear steps how a trainee can submit this assignment.
47-
placeholder: |
55+
value: |
4856
Fork the repo to your own GitHub account
4957
Make regular small commits with clear messages
5058
When you are ready, open a Pull Request to the CYF repo
@@ -73,8 +81,8 @@ body:
7381
- priority -- is this coursework key, mandatory, or stretch? Pick one.
7482
- size -- help trainees plan their time with rough estimation. Pick one
7583
- topics -- add all that seem relevant to you.
76-
2. Add to milestone
77-
- week 1,2,3,4
84+
2. Add a Sprint label to add to the backlog view
85+
- sprint 1,2,3,4
7886
7987
Once your ticket is complete, you may like to add it to the example project board attached to this repo.
8088
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‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Self checklist
2020
- [ ] I have committed my files one by one, on purpose, and for a reason
2121
- [ ] I have titled my PR with COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME | WEEK
2222
- [ ] I have tested my changes
23-
- [ ] My changes follow the [style guide](https://curriculum.codeyourfuture.io/guides/contributing/)
23+
- [ ] 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

2626
## Changelist

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
**/.DS_Store
2+
.DS_Store
3+
node_modules/
4+
.vscode/

‎Example-Image.jpeg‎

-910 KB
Binary file not shown.

‎Form-Controls/README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Form Controls
2+
3+
## Learning Objectives
4+
5+
<!--{{<objectives>}}>-->
6+
7+
- [ ] Interpret requirements and check against a list of criteria
8+
- [ ] Write a valid form
9+
- [ ] Test with Devtools
10+
- [ ] Refactor using Devtools
11+
<!--{{<objectives>}}>-->
12+
13+
## Task
14+
15+
We are selling t-shirts. Write a form to collect the following data:
16+
17+
Our customers already have accounts, so we know their addresses and charging details already. We don't need to collect that data. We want to confirm they are the right person, then get them to choose a colour and size.
18+
19+
Writing that out as a series of questions to ask yourself:
20+
21+
1. What is the customer's name? I must collect this data, and validate it. But what is a valid name? I must decide something.
22+
2. What is the customer's email? I must make sure the email is valid. Email addresses have a consistent pattern.
23+
3. What colour should this t-shirt be? I must give 3 options. How will I make sure they don't pick other colours?
24+
4. What size does the customer want? I must give the following 6 options: XS, S, M, L, XL, XXL
25+
26+
All fields are required.
27+
Do not write a form action for this project.
28+
29+
## Developers must test their work.
30+
31+
Let's write out our testable criteria. Check each one off as you complete it.
32+
33+
- [ ] I have used HTML only.
34+
- [x] I have not used any CSS or JavaScript.
35+
36+
### HTML
37+
38+
- [ ] My form is semantic html.
39+
- [ ] All inputs have associated labels.
40+
- [ ] My Lighthouse Accessibility score is 100.
41+
- [ ] I require a valid name. I have defined a valid name as a text string of two characters or more.
42+
- [ ] I require a valid email.
43+
- [ ] I require one colour from a defined set of 3 colours.
44+
- [ ] I require one size from a defined set of 6 sizes.
45+
46+
## Resources
47+
48+
- [MDN: Form controls](https://developer.mozilla.org/en-US/docs/Learn/Forms)
49+
- [MDN: Form validation](https://developer.mozilla.org/en-US/docs/Learn/Forms/Form_validation)
50+
- [Lighthouse](https://developers.google.com/web/tools/lighthouse)
51+
- [Lighthouse Guide](https://programming.codeyourfuture.io/guides/testing/lighthouse)

‎Form-Controls/index.html‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
6+
<title>My form exercise</title>
7+
<meta name="description" content="" />
8+
<meta name="viewport" content="width=device-width, initial-scale=1" />
9+
</head>
10+
<body>
11+
<header>
12+
<h1>Product Pick</h1>
13+
</header>
14+
<main>
15+
<form>
16+
<!-- write your html here-->
17+
<!--
18+
try writing out the requirements first as comments
19+
this will also help you fill in your PR message later-->
20+
</form>
21+
</main>
22+
<footer>
23+
<!-- change to your name-->
24+
<h2>By HOMEWORK SOLUTION</h2>
25+
</footer>
26+
</body>
27+
</html>

‎HOW_TO_REVIEW.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
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-
71
# Everyone reviews code at CYF
82

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.
3+
[![Code Review Flow](code-review-flow.png)](https://curriculum.codeyourfuture.io/guides/reviewing/)
4+
5+
https://curriculum.codeyourfuture.io/guides/reviewing/
6+
7+
Mentors and participants all review code, and collaborate on improving code quality. We are all helping each other to talk, write, and think about code more clearly.
108

119
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.
1210

@@ -24,12 +22,24 @@ We are not reviewing code as if we were to merge this PR into production; we are
2422

2523
3. Respect everyone's work and time:
2624

27-
**YES** "I think there's some more to do here. Thanks for sharing where you're up to."
25+
**YES** "I think there's some more to do here. Thanks for sharing where you're up to. Can I help you complete this?"
2826
**NO** "This is rubbish. Try harder."
2927

30-
## Labels
28+
## Getting your pull request reviewed
29+
30+
We're using GitHub Labels in our Code Review process. In order for a volunteer to review a pull request, a participant will need to add a "Needs Review" label to it.
31+
32+
To add a label to a pull request:
33+
34+
- Open the pull request
35+
- In the right sidebar, click Labels, then select the label you'd like to add - for example: "Needs Review"
36+
37+
Take a look at our code review process from beginning to end. Let us know if you have any questions or need help!
38+
![Code Review Flow](code-review-flow.png)
3139

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.
40+
## Labels for feedback
41+
42+
Reviewers, please add labels (provided) to the PR once you've reviewed. This helps to focus the participant on the areas they should work on, and gives an overview for mentors on what the whole cohort needs to work on.
3343

3444
## Solutions
3545

@@ -53,14 +63,4 @@ Use these resources to inform your code review, get unstuck, and improve your un
5363

5464
## Guides
5565

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
66+
https://curriculum.codeyourfuture.io/guides/reviewing/

0 commit comments

Comments
 (0)