Commit eee1f9a6 authored by Rémi Emonet's avatar Rémi Emonet
Browse files

Merge remote-tracking branch 'origin/gh-pages' into update-mailmap-and-authors

parents f80f3015 110880f9

CONTRIBUTING.md

+2 −1
Original line number Diff line number Diff line
@@ -102,7 +102,8 @@ you may want to look at 
[How to Contribute to an Open Source Project on GitHub][how-contribute].

In brief:



1.  The published copy of the lesson is in the [episodes][episodes] directory in the `gh-pages` branch of the repository

1.  The published copy of the lesson is in the [episodes][episodes] directory

    in the `gh-pages` branch of the repository

    (so that GitHub will regenerate it automatically).

    Please create all branches from that,

    and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch

Makefile

+1 −1
Original line number Diff line number Diff line
@@ -93,7 +93,7 @@ lesson-check : 


## lesson-check-all : validate lesson Markdown, checking line lengths and trailing whitespace.

lesson-check-all :

	@bin/lesson_check.py -s . -p ${PARSER} -l -w

	@bin/lesson_check.py -s . -p ${PARSER} -r _includes/links.md -l -w



## lesson-figures   : re-generate inclusion displaying all figures.

lesson-figures :

_config.yml

+1 −1
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ carpentry: "swc" 
title: "Lesson Title"



# Contact email address.

email: lessons@software-carpentry.org

contact: "mailto:lessons@software-carpentry.org"



#------------------------------------------------------------

# Generic settings (should not need to change).

_episodes/01-design.md

+8 −3
Original line number Diff line number Diff line
@@ -70,7 +70,8 @@ In practice, the process often looks more like this: 
2.  Describe the summative assessments for each half day of material

    (i.e., one summative assessment for a three-hour lesson and two for a full-day lesson).



3.  Write a one- or two-line description of the formative assessments building up to those summative assessments.

3.  Write a one- or two-line description of the formative assessments

    building up to those summative assessments.

    These should be paced at roughly 15-minute intervals,

    i.e.,

    four per hour.
@@ -103,8 +104,12 @@ then formative assessments should take no more than 5 minutes. 
This means that formative assessments should be:



*   multiple choice questions,

*   Parsons Problems (in which the learner is given the parts of the solution in scrambled order and has to put them in the right order),

*   debugging exercises (in which the learner is given a few lines of code that do the wrong thing and asked to find and fix the bug), or

*   Parsons Problems

    (in which the learner is given the parts of the solution in scrambled order

    and has to put them in the right order),

*   debugging exercises

    (in which the learner is given a few lines of code that do the wrong thing

    and asked to find and fix the bug), or

*   extensions of examples show in the lecture.



Good formative assessments do *not* require learners to write lots of code from scratch:

_episodes/02-tooling.md

+4 −2
Original line number Diff line number Diff line
@@ -22,8 +22,10 @@ These simplify many tasks, but make other things more complicated. 
## Repositories on GitHub



Our lessons are stored in Git repositories (or "repos") on GitHub.

We use the term *fork* to mean "a copy of a GitHub-hosted repo that is also hosted on GitHub"

and the term *clone* to mean "a copy of a GitHub-hosted repo that's located on someone else's machine".

We use the term *fork* to mean

"a copy of a GitHub-hosted repo that is also hosted on GitHub"

and the term *clone* to mean

"a copy of a GitHub-hosted repo that's located on someone else's machine".

In both cases,

the duplicate has a reference that points to the original repo.