Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
SallyMcGrath authored Nov 11, 2023
0 parents commit 48e9672
Show file tree
Hide file tree
Showing 8 changed files with 296 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github: CodeYourFuture
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: https://codeyourfuture.io/donate
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: CYF
url: [email protected]
about: Please report serious issues here.
- name: Join CYF
url: https://codeyourfuture.io/volunteers/
about: Join CYF here
- name: CYF Slack
url: codeyourfuture.slack.com
about: Come to #cyf-syllabus-tech and chat
- name: CYF Tech Ed
url: https://github.com/orgs/CodeYourFuture/teams/mentors
about: CYF mentors on Github
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/pd-assignment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: PD Coursework
description: Assign a piece of PD coursework
title: "[PD] <title>"
labels: [PD, 🏝 Priority Stretch, 🐇 Size Small]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to assign this coursework!
- type: input
attributes:
label: Coursework content
validations:
required: true
- type: input
attributes:
label: Estimated time in hours
description: (PD has max 4 per week total)
validations:
required: true
- type: textarea
attributes:
label: What is the purpose of this assignment?
description: Clearly explain the purpose of this assignment and how trainees can evaluate this.
validations:
required: true
- type: textarea
attributes:
label: How to submit
description: State in clear steps how a trainee can submit this assignment.
placeholder: |
Copy the Google doc to your own Google Drive
Complete the work assigned
When you are ready, move your document to your class Drive
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give more context
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
- type: markdown
attributes:
value: |
**Thank you so much.**
Please now complete this ticket by filling in the options on the sidebar.
1. Update labels
- priority -- is this coursework key, mandatory, or stretch?
- size -- help trainees plan their time with rough estimation
2. Add to project backlog
- add to the project named the same as this repo
- fill in custom fields -- priority, size, hours, week -- to match this issue
Once your ticket is complete, you may like to check it out on the example project board attached to this repo.
This is so you understand how trainees will use your work.
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/tech-ed-assignment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Tech Ed Coursework
description: Assign a piece of technical coursework
title: "[TECH ED] <title>"
labels: [Tech Ed, 🏕 Priority Mandatory, 🐂 Size Medium]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to assign this coursework!
To support our trainees with planning and prioritising their own learning journey, we want our coursework assignments to be more informative.
We don't just want to tell them what to do, we want to tell them stuff like:
- why we are doing it
- what it's "for" (problem-solving, debugging, etc)
- how long they should spend on it, maximum
- how to get help
- how to review it with answers
- how to get it reviewed from mentors and peers
- type: input
attributes:
label: Link to the coursework
validations:
required: true
- type: textarea
attributes:
label: Why are we doing this?
description: Clearly explain the purpose of this assignment
validations:
required: true
- type: input
attributes:
label: Maximum time in hours
description: (Tech has max 16 per week total)
validations:
required: true
- type: textarea
attributes:
label: How to get help
description: State simply how trainees can get help with this assignment
placeholder: |
Share your blockers in your class channel
https://syllabus.codeyourfuture.io/guides/asking-questions
- type: textarea
attributes:
label: How to submit
description: State in clear steps how a trainee can submit this assignment.
placeholder: |
Fork the repo to your own GitHub account
Make regular small commits with clear messages
When you are ready, open a Pull Request to the CYF repo
Make sure you fill in the PR template provided
validations:
required: true
- type: textarea
attributes:
label: How to review
description: How to get code review and how to self-review
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give more context
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
- type: markdown
attributes:
value: |
**Thank you so much.**
Please now complete this ticket by filling in the options on the sidebar.
1. Update labels
- priority -- is this coursework key, mandatory, or stretch? Pick one.
- size -- help trainees plan their time with rough estimation. Pick one
- topics -- add all that seem relevant to you.
2. Add to milestone
- week 1,2,3,4
Once your ticket is complete, you may like to add it to the example project board attached to this repo.
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.
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
You must title your PR like this:
COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME | WEEK
For example,
NW4 | Carol Owen | HTML-CSS-Module | Week1
Complete the task list below this message.
If your PR is rejected, check the task list.
-->

## Learners, PR Template

Self checklist

- [ ] I have committed my files one by one, on purpose, and for a reason
- [ ] I have titled my PR with COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME | WEEK
- [ ] I have tested my changes
- [ ] My changes follow the [style guide](https://syllabus.codeyourfuture.io/guides/code-style-guide/)
- [ ] My changes meet the [requirements](./README.md) of this task

## Changelist

Briefly explain your PR.

## Questions

Ask any questions you have for your reviewer.
66 changes: 66 additions & 0 deletions HOW_TO_REVIEW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<!--
Do not edit this file.
Make a change to the template and then pull changes
Repo: https://github.com/CodeYourFuture/Module-Template
-->

# Everyone reviews code at CYF

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.

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.

## Key points:

1. Ask questions instead of making statements:

**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?"
**NO:** "Use fieldset not divs"

2. Encourage simplicity, clarity, and precision:

**YES** "There are 15,0000 files in this changelist. Which files should be reviewed?"
**NO** "It doesn't matter; I can try to figure out what you meant."

3. Respect everyone's work and time:

**YES** "I think there's some more to do here. Thanks for sharing where you're up to."
**NO** "This is rubbish. Try harder."

## Labels

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.

## Solutions

### Where to find solutions?

You can find the solutions for the module on the `solutions` branch.

### Solutions branch

The solutions branch typically contains:

#### Sample solutions

Solutions are example answers not the only correct answers.

#### Common responses guides.

Everyone is invited to contribute commonly encountered problems, mistakes, misunderstandings, and mental-model errors to our common responses documents.

Use these resources to inform your code review, get unstuck, and improve your understanding.

## Guides

Here's a detailed checklist of the sorts of things we should check code for:

https://syllabus.codeyourfuture.io/guides/marking-guide

Here's a detailed style guide to help us all write clear, high quality code:

https://syllabus.codeyourfuture.io/guides/code-style-guide

Here's some help with giving good feedback during code review:

https://teachertraining.codeyourfuture.io/tasks/code-review
25 changes: 25 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!--
Do not edit this file.
Make a change to the template and then pull changes
Repo: https://github.com/CodeYourFuture/Module-Template
-->

# How To Submit Your Coursework

Use Git & Github to submit your coursework as a pull request.

The Github Desktop cheatsheet will help you.

[Github Desktop Cheatsheet](http://syllabus.codeyourfuture.io/git/cheatsheet)

This module will help you submit your coursework.

[Git](http://syllabus.codeyourfuture.io/git/index)

## Questions & Help

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.

If you cannot submit your coursework you **must** post on Slack to get unblocked.

[How to get help](./HOW-TO-GET-HELP.md)
7 changes: 7 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# TEMPLATE repo for Modules

## Tasks
- [ ] Set up example board
- [ ] Populate repo with coursework issues from Google Classroom Boilerplate
- [ ] Add core Actions from org store https://docs.github.com/en/actions/creating-actions/sharing-actions-and-workflows-with-your-organization

0 comments on commit 48e9672

Please sign in to comment.