Skip to content

docs(readme): clarify this is the upstream template, not a student repo #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lassebenni merged 1 commit into from
May 5, 2026
Merged

docs(readme): clarify this is the upstream template, not a student repo #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
# Data Track — Week 1 Assignment
# Data Track — Week 1 Assignment (Template)

The HackYourFuture Data Track Week 1 assignment: **The Data Cleaning Pipeline**.

> Full instructions, learning context, and submission flow live in the
> curriculum chapter:
> 👩‍🎓 **Students:** you are in the wrong place. Do **not** fork or use this template.
> Go to your cohort's assignment repo under
> [`HackYourAssignment`](https://github.com/HackYourAssignment) (e.g. `c55-data-week1`,
> `c56-data-week1`, …). Your teacher posts the exact link in your cohort channel.
> Fork the cohort repo, branch, and open a PR back to it. Full instructions live in the
> [Week 1 Assignment on Notion](https://www.notion.so/hackyourfuture/Week-1-Assignment-The-Data-Cleaning-Pipeline-3cc37d4bf482470cbc6667bd1d1bb605).
> Read it first; this README is a quick reference.

## How to start
## For instructors / track maintainers

1. Click **Use this template** → **Create a new repository** under your own GitHub account.
2. Clone *your* copy locally.
3. `git switch -c week1-attempt`
4. Work through the three tasks below.
5. Push and open a PR against your repo's `main`. The auto-grader runs on every push and posts a score comment.
This repo is the **upstream template** for the Week 1 assignment. At the start of each
cohort, generate a cohort-specific repo under the `HackYourAssignment` org from this
template (GitHub: **Use this template → Create a new repository**, owner =
`HackYourAssignment`, name = `c<NN>-data-week1`). Students then fork *that* cohort repo
and open PRs back to it; the auto-grader runs on every push.

Edits to the assignment, dataset, or grader belong here on the template, not on the
cohort copies.

## Tasks at a glance

Expand Down Expand Up @@ -61,4 +66,6 @@ This prints a per-task breakdown and writes `score.json`. Iterate until

## Submission

Open a PR against your fork's `main`. Share the PR URL with your teacher.
Students submit on the cohort repo (`HackYourAssignment/c<NN>-data-week1`), not here:
open a PR from the student's fork against the cohort repo's `main`, then share the PR
URL with the teacher.