Skip to content
rlaemmel edited this page Oct 10, 2012 · 9 revisions

Table of Contents

Workflow for contributions

It's easy:

  1. Identify and prepare the artifacts of your contribution.
  2. Make the artifacts publicly available as sustainable resources.
  3. Summarize your contribution briefly on the SLECOURSE wiki.
  4. Add your contribution to the list of contributions.
  5. Communicate your contribution via Twitter, email, or other means.
See more advice and options on the steps listed above.

If you need help, please, contact SLECOURSE at slecourse@gmail.com.

Forms of resources

By "form" we mean the kind of artifact that constitutes a resource of a contribution. Presumably, slides (to be used for lectures) correspond the most obvious form of contributions. Other forms include sources (of samples or systems for coverage in lectures or labs) and exams or exercises (in the sense of lists of questions with or without answers).

Delivery of contributions

In principle, contributors may like to host the resources of their contributions, and that's Ok. In that case, just make sure that the resources, as you link them on the wiki page for the contribution, remains available "forever". Please consider, though, sharing all artifacts via SLECOURSE's Dropbox folder or SLECOURSE's GitHub repository. In that case, invent a nice, lower-case-starting CamelCase directory name for use within the sharing areas. You can request shared access to the Dropbox folder and push rights for the GitHub repository by sending an email to SLECOURSE at slecourse@gmail.com.

Description of contributions

Have a look at examples of contributions.

In fact, copy and paste the description of a fitting example when describing your contribution.

The following sections are recommended.

  • Headline: a short headline or caption for the contribution.
  • Contributor(s): the authors of the contribution (slides, sources, etc.).
  • Summary: a short summary or abstract describing the contribution in free text.
  • Tagging: some tags helping with the classification of the contributed resources.
  • Resources: the list of linked resources making up the contribution.
  • Events: the timeline for the contribution (e.g., when it was added to SLECOURSE).
Sections can be omitted, if it helps to get in your contribution.

Modularity of contributions

Opinions will vary on what should be in an SLE course, how to do it, what order to choose, etc. Hence, ideally, contributions should propose units of a course as opposed to monolithic courses. This would allow everyone to comprehend and reuse contributions more efficiently. So if you have done an SLE-ish course in the past or if you are running one now, start by contributing the most "reusable" pieces of it, i.e., the "filets" of the course, or make several contributions rather than one.

Attachment of credits

If you want to contribute course material (slides, sources, etc.), please make sure that it is legally and morally and in every other relevant way **Ok to expose the material** publicly through the "SLE course" project. Applicable credits or licenses should be attached in strikingly clear manner to all relevant artifacts. For instance, credits could take the form of a small footer on each and every slide; source directories could contain a COPYRIGHT file, which hopefully allows for very liberal use in education. As far as your contribution is concerned, as a recommendation, consider using http://creativecommons.org/, where you can easily choose a license and attach to your contribution. Further reading: good practices.

Means of communication

Twittering is Ok; follow @slecourse. Emailing is Ok; leverage slecourse@gmail.com as a broker, if it helps. The use of GitHub's issue mechanism is Ok. If you like http://planet-sl.org, consider using the designated group on said planet.

The Creative Commons Attribution License applies to the wiki content. Specific licenses may apply to individual contributions.