Skip to content

Commit

Permalink
Merge branch 'core' of github.com:swcarpentry/lesson-template into me…
Browse files Browse the repository at this point in the history
…rge-core
  • Loading branch information
iglpdc committed Feb 22, 2015
2 parents 2a89ab3 + b489aa6 commit b7dcedc
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ README.html
LAYOUT.html
FAQ.html
DESIGN.html
CONTRIBUTING.html
*~
*.pyc
_site
Expand Down
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Software Carpentry is an open source project,
and we welcome contributions of all kinds:
new lessons,
fixes to existing material,
bug reports,
and reviews of proposed changes are all equally welcome.

By contributing,
you are agreeing that Software Carpentry may redistribute your work under
[these licenses][license].

## Getting Started

1. We use GitHub flow to manage changes,
which is explained in the chapter [Contributing to a Project][pro-git-chapter]
in Scott Chacon's book *Pro Git*.

2. For our lessons,
you should branch from and submit pull requests against the `gh-pages` branch.

3. When editing lesson pages, you need only commit changes to the Markdown source files.

4. If you're looking for things to work on,
please see [the list of issues for this repository][lesson-template-issues],
or for [our other lessons][swc-lessons].
Comments on issues and reviews of pull requests are equally welcome.

## Other Resources

1. This lesson is based on the template found at
[https://github.com/swcarpentry/lesson-template](https://github.com/swcarpentry/lesson-template).
That repository has instructions on formatting and previewing lessons.

2. For a list of helpful commands run `make` in this directory.

3. The [list of maintainers][swc-maintainers]
on the [Software Carpentry website][swc-website]
lists the people currently responsible for managing this repository.
Feel free to contact them if you have any questions or languishing pull requests.

[lesson-template-issues]: https://github.com/swcarpentry/lesson-template/issues
[license]: LICENSE.md
[pro-git-chapter]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project
[swc-lessons]: http://software-carpentry.org/lessons.html
[swc-maintainers]: http://software-carpentry.org/lessons.html#maintainers
[swc-website]: http://software-carpentry.org
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ DST_RMD = $(patsubst %.Rmd,%.md,$(SRC_RMD))

# All Markdown files (hand-written and generated).
ALL_MD = $(wildcard *.md) $(DST_RMD)
EXCLUDE_MD = README.md LAYOUT.md FAQ.md DESIGN.md
EXCLUDE_MD = README.md LAYOUT.md FAQ.md DESIGN.md CONTRIBUTING.md
SRC_MD = $(filter-out $(EXCLUDE_MD),$(ALL_MD))
DST_HTML = $(patsubst %.md,%.html,$(SRC_MD))

Expand Down
6 changes: 3 additions & 3 deletions tools/setup-labels
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ fi
OWNER=$1
REPO=$2
GITHUB_URL=https://github.com/${OWNER}/${REPO}
LABELS=(bug defer discussion duplicate enhancement filed-by-newcomer getting-started help-wanted left-as-was suitable-for-newcomer work-in-progress)
COLORS=(FF0000 66FF00 0000FF 98FB98 E0115F FFFF00 808000 89CFF0 568203 FCE883 545AA7)
LABELS_TO_DELETE=(help%20wanted invalid question wontfix)
LABELS=(bug build defer discussion documentation enhancement newcomer-friendly upstream work-in-progress)
COLORS=(FF0000 551033 66FF00 0000FF D4318C E0115F FCE883 83F52C 545AA7)
LABELS_TO_DELETE=(duplicate filed-by-newcomer getting-started help%20wanted help-wanted invalid left-as-was suitable-for-newcomer question wontfix)

# Test if repository exists
curl -s --head ${GITHUB_URL} | head -n 1 | grep -q "HTTP/1.[01] [23].."
Expand Down

0 comments on commit b7dcedc

Please sign in to comment.