"""Initialize a newly-created repository."""
-from __future__ import print_function
import sys
import os
There are many ways to contribute,
from writing new exercises and improving existing ones
to updating or filling in the documentation
-and and submitting [bug reports][issues]
+and submitting [bug reports][issues]
about things that don't work, aren't clear, or are missing.
If you are looking for ideas, please see the 'Issues' tab for
a list of issues associated with this repository,
If you choose to contribute via GitHub, you may want to look at
[How to Contribute to an Open Source Project on GitHub][how-contribute].
-To manage changes, we follow [GitHub flow][github-flow].
+To manage changes, we follow [GitHub flow][github-flow].
Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
The maintainers are community volunteers and have final say over what gets merged into the lesson.
To use the web interface for contributing to a lesson:
-1. Fork the master repository to your GitHub profile.
+1. Fork the originating repository to your GitHub profile.
2. Within your version of the forked repository, move to the `gh-pages` branch and
create a new branch for each significant change being made.
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
4. Commit all changed files within the appropriate branches.
5. Create individual pull requests from each of your changed branches
-to the `gh-pages` branch within the master repository.
+to the `gh-pages` branch within the originating repository.
6. If you receive feedback, make changes using your issue-specific branches of the forked
repository and the pull requests will update automatically.
7. Repeat as needed until all feedback has been addressed.
-When starting work, please make sure your clone of the master `gh-pages` branch is up-to-date
+When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
before creating your own revision-specific branch(es) from there.
Additionally, please only work from your newly-created branch(es) and *not*
-your clone of the master `gh-pages` branch.
-Lastly, published copies of all the lessons are available in the `gh-pages` branch of the master
+your clone of the originating `gh-pages` branch.
+Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
repository for reference while revising.
## Other Resources
# Sites.
amy_site: "https://amy.software-carpentry.org/workshops"
+carpentries_github: "https://github.com/carpentries"
+carpentries_pages: "https://carpentries.github.io"
+carpentries_site: "https://carpentries.org/"
dc_site: "http://datacarpentry.org"
+example_repo: "https://github.com/swcarpentry/lesson-example"
+example_site: "https://swcarpentry.github.com/lesson-example"
+lc_site: "https://librarycarpentry.github.io/"
swc_github: "https://github.com/swcarpentry"
-swc_site: "https://software-carpentry.org"
swc_pages: "https://swcarpentry.github.io"
-lc_site: "https://librarycarpentry.github.io/"
+swc_site: "https://software-carpentry.org"
template_repo: "https://github.com/swcarpentry/styles"
-example_repo: "https://github.com/swcarpentry/lesson-example"
-example_site: "https://swcarpentry.github.com/lesson-example"
+training_site: "https://swcarpentry.github.io/instructor-training"
workshop_repo: "https://github.com/swcarpentry/workshop-template"
workshop_site: "https://swcarpentry.github.io/workshop-template"
-training_site: "https://swcarpentry.github.io/instructor-training"
# Surveys.
pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
ROOT_AIO_MD = '''\
---
-layout: page
+layout: page
root: .
---
<script>
projects / rnaseq-cwl-training.git / blobdiff