Skip to content

Commit

Permalink
Merge branch 'main' of github.com:CodeYourFuture/curriculum into minu…
Browse files Browse the repository at this point in the history
…tes-2024-01-16
  • Loading branch information
Dedekind561 committed Jan 23, 2024
2 parents 13036b2 + c7e6c28 commit f99d80f
Show file tree
Hide file tree
Showing 880 changed files with 2,939 additions and 974 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/check-consistency.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Check consistency

on:
pull_request:
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: 1.21
- name: Build tooling
run: (cd tooling/go && go build ./cmd/local-overrides-enforcer)
- name: Check consistency
run: ./tooling/go/local-overrides-enforcer
17 changes: 17 additions & 0 deletions .github/workflows/test-tooling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Test tooling

on:
pull_request:
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: 1.21
- name: Run tooling tests
run: cd tooling/go && go test ./...
File renamed without changes.
185 changes: 35 additions & 150 deletions README.md

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
+++
title = 'Understanding Requirements'
headless = true
time = 20
facilitation = false
vocabulary=["Requirements", "User Stories"]
emoji= '🧩'
[objectives]
1='Identify described requirements'
2='Identify extra requirements from your own experience'
3='Resolve trade-offs in conflicting requirements'
4='Translate requirements into high-level design outlines'
+++

Communication is _hard_. Today, let’s explore some ways we communicate with each other in software development. It’s not enough to draw a picture of a website and assume the other person will build what you imagine. It’s never a good idea to assume shared context or shared interpretations.

So how do we understand what to do? By understanding **requirements**.
Expand All @@ -17,9 +31,3 @@ We're going to think about a few projects and discover some requirements. This i
{{<note type="tip" title="Remember" >}}
To make great software, we need to think about people, not just code.
{{</note>}}

### User Stories

We can discover requirements with something called 'User Stories'. The simplest user story looks like this:

> As a [type of user], I can [achieve some goal].
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ emoji= '🧩'
4='Translate requirements into high-level design outlines'
+++

{{< snippet "snippets/requirements.md" >}}

#### Imagine a coursework tracker

As trainees, you have coursework to do. Imagine a website which tracks how coursework is going for you all. Thinking about that website, some user stories could be:
Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ emoji= '🧩'
2='Identify and explain the key user stories for your project'
+++

{{< snippet "snippets/requirements.md" >}}

In addition to [who] and [what], good user stories also include [why]

> As a [who], I can [what] so that **[why]**
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions common-content/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module github.com/CodeYourFuture/curriculum/common-content

go 1.21.3
5 changes: 5 additions & 0 deletions common-content/hugo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

[module]
[module.hugoVersion]
extended = true
min = "0.116.0"
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions common-theme/assets/images/site-logo/logo.svg
10 changes: 10 additions & 0 deletions common-theme/assets/jsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"*": [
"*"
]
}
}
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit f99d80f

Please sign in to comment.