Skip to content

Commit

Permalink
docs: 📝 update text by simplifying a bit (#60)
Browse files Browse the repository at this point in the history
## Description

This PR completes some minor text edits in the `syllabus.qmd`. 

Mainly, I have tried to remove words and sentences that are (/that I
deem) unnecessary to try to keep things a bit simpler and more to the
point :)

I also fixed a layout issue with the nested lists. 

Closes #14 (this issue is the reason why I started going through this
file, but it was almost filled out already)

## Reviewer Focus

This PR needs an in-depth review. 

## Checklist

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

---------

Co-authored-by: Luke W. Johnston <[email protected]>
  • Loading branch information
signekb and lwjohnst86 authored Nov 7, 2024
1 parent 1c56bb5 commit 518c226
Showing 1 changed file with 38 additions and 51 deletions.
89 changes: 38 additions & 51 deletions preamble/syllabus.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,45 +7,55 @@
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.
workflows and use Git and GitHub with approaches that 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.
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.
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.
and explain 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).
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), and
4. contributing those changes to the project (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.
1. reviewing a pull request,
2. giving suggestions and feedback, and
3. identifying how (and if) the changes should be merged into
project.

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

This course will cover:

- Using Git and GitHub with VS Code and the GitHub web interface
- Working with at least one other person on a project (*a Git
repository*)
- Working with plain text files (as Markdown `.md`)

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) and Kanban boards

To help manage expectations and develop the material for this course, we
make a few assumptions about *who you are* as a participant in the
course:
Expand All @@ -54,34 +64,11 @@ course:
common set of files
- You have a desire to work together in a more open and transparent
way in your team(s)
- You have used Git and/or GitHub a bit, either through GitHub's UI,
RStudio, VS Code, Jupyter Lab/Notebook, or GitHub Desktop, but not regularly or in a team or a
collaborative setting.

While we have these assumptions to help focus the content of the course,
if you have an interest in learning what we teach but don't fit any of
the above assumptions, *you are still welcome to attend the course*! We
welcome everyone, that is until the course capacity is reached.

In addition to the assumptions, we also have a fairly focused scope for
teaching and expectations for learning. So this may also help you decide
if this course is for you.

This course will cover:

- Using Git

- Using GitHub

- Working with at least one other person

- Using \<IDE\>

- Working with plain text files (as Markdown `.md` )

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)
- You've used Git and/or GitHub a bit, maybe through GitHub's web
interface, RStudio, VS Code, Jupyter Lab/Notebook, or GitHub
Desktop, but not often or in a collaborative setting.

These assumptions help guide the course content, but if you don't meet
the assumption but are interested in learning, *you’re still welcome to
join*! We welcome everyone, that is until the course capacity is
reached.

0 comments on commit 518c226

Please sign in to comment.