Skip to content

Commit b3cddd4

Browse files
illicitonionillicitonion
committed
Initial commit
0 parents  commit b3cddd4

File tree

6 files changed

+215
-0
lines changed

6 files changed

+215
-0
lines changed

‎.github/FUNDING.yml

Lines changed: 13 additions & 0 deletions
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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: true
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

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]
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

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
name: Tech Ed Coursework
2+
description: Assign a piece of technical coursework
3+
title: "<title>"
4+
labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium, 📅 Module 1]
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: Learning Objectives
27+
description: https://common.codeyourfuture.io/common-theme/shortcodes/objectives/
28+
placeholder: |
29+
<!--{{<objectives}}-->
30+
- [ ] CYF format, task list formatting
31+
<!--{{</objectives}}-->
32+
- type: textarea
33+
attributes:
34+
label: Why are we doing this?
35+
description: Clearly explain the purpose of this assignment
36+
validations:
37+
required: true
38+
- type: input
39+
attributes:
40+
label: Maximum time in hours
41+
description: (Tech has max 16 per week total)
42+
validations:
43+
required: true
44+
- type: textarea
45+
attributes:
46+
label: How to get help
47+
description: State simply how trainees can get help with this assignment
48+
value: |
49+
Share your blockers in your class channel
50+
https://curriculum.codeyourfuture.io/guides/getting-help/asking-questions/
51+
- type: textarea
52+
attributes:
53+
label: How to submit
54+
description: State in clear steps how a trainee can submit this assignment.
55+
value: |
56+
Fork the repo to your own GitHub account
57+
Make regular small commits with clear messages
58+
When you are ready, open a Pull Request to the CYF repo
59+
Make sure you fill in the PR template provided
60+
validations:
61+
required: true
62+
- type: textarea
63+
attributes:
64+
label: How to review
65+
description: How to get code review and how to self-review
66+
- type: textarea
67+
attributes:
68+
label: Anything else?
69+
description: |
70+
Links? References? Anything that will give more context
71+
72+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
73+
- type: markdown
74+
attributes:
75+
value: |
76+
**Thank you so much.**
77+
78+
Please now complete this ticket by filling in the options on the sidebar.
79+
80+
1. Update labels
81+
- priority -- is this coursework key, mandatory, or stretch? Pick one.
82+
- size -- help trainees plan their time with rough estimation. Pick one
83+
- topics -- add all that seem relevant to you.
84+
2. Add a Sprint label to add to the backlog view
85+
- sprint 1,2,3,4
86+
87+
Once your ticket is complete, you may like to add it to the example project board attached to this repo.
88+
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: 32 additions & 0 deletions
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.

‎README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Module-Legacy-Code
2+
3+
This repository hosts an existing codebase for you to work with.
4+
5+
The codebase is a web-app called PurpleForest. It consists of a single-page application frontend written in JavaScript, a backend written in Python, and a PostgreSQL database.
6+
7+
The repository contains a number of bug reports and feature requests as issues in this repo.
8+
9+
Your objective is to understand the codebase, debug and fix the bug reports, and implement the feature requests.

0 commit comments

Comments
 (0)