Skip to content

Commit

Permalink
docs(sessions): 📝 include learning outcomes for course (#46)
Browse files Browse the repository at this point in the history
## Description

Closes #4

## Reviewer Focus

This PR needs an in-depth review. 

## Checklist

- [x] Ran spell-check
- [x] Formatted Markdown
- [x] Rendered website locally

---------

Co-authored-by: Signe Kirk Brødbæk <[email protected]>
  • Loading branch information
lwjohnst86 and signekb authored Oct 7, 2024
1 parent ac0958f commit 6252366
Showing 1 changed file with 42 additions and 4 deletions.
46 changes: 42 additions & 4 deletions preamble/syllabus.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,47 @@

{{< include ../includes/_wip.qmd >}}

Objectives:

- Item 1
## Learning outcomes

Our overall learning outcome for the course is:

1. Describe some core features of effective team-based, collaborative
workflows and identify the components that make these workflows
effective compared to other workflows. Then use Git and GitHub with
approaches that strongly support effective collaboration.

This outcome is broken down into specific learning objectives that will
be addressed within the individual sessions:

1. Explain what humans, both psychologically and
organizationally, need in order to work well together as a team.
2. Discuss the different ways people work together as a team and
identify how some of these ways work better than others for effective
teamwork.
3. Describe how the widely used Git and GitHub are used for
collaboration, explain their biggest strengths and weaknesses
compared to alternatives, and review the basics of using Git and
GitHub.
4. Set up a project on GitHub (called a repository) and apply some key
settings on GitHub to improve collaboration and teamwork.
5. Differentiate between contributor and reviewer/admin roles in a team
and why they should be dynamic and explicit.
6. Create and use a task list (called issues) to assign team members to
tasks that they are responsible for.
7. Apply a contributor workflow that involves:
1. selecting an issue to work on,
2. creating an isolated section of a repository (called
branches),
3. making small and distinct changes to files (known as
atomic commits) with clear messages explaining why or what
was changed, and
4. contributing those changes into the main branch
of a repository (called pull requests).
8. Apply a reviewer/admin workflow that involves:
1. reviewing a pull request with changes,
2. giving suggestions and feedback, and
3. identifying how (and if) the changes should be merged
back into the main branch of a repository.

## Is this course for you? {#sec-is-it-for-you}

Expand Down Expand Up @@ -46,4 +84,4 @@ This course will **NOT** cover:
- Using any programming language (like R or Python)

- Any project management, for example related to tasks/issues (even
though we briefly cover issues)
though we briefly cover issues)

0 comments on commit 6252366

Please sign in to comment.