Skip to content
This repository has been archived by the owner on Jan 3, 2018. It is now read-only.

A generic CONTRIBUTING file #170

Merged
merged 3 commits into from
Feb 13, 2015
Merged

A generic CONTRIBUTING file #170

merged 3 commits into from
Feb 13, 2015

Conversation

gvwilson
Copy link
Contributor

This adds a CONTRIBUTING.md file to core for use in all lessons based on one written by @ChristinaLK for the novice shell lesson.

@wking
Copy link
Contributor

wking commented Feb 12, 2015

On Wed, Feb 11, 2015 at 06:18:14PM -0800, Greg Wilson wrote:

  • A generic CONTRIBUTING file
  • There's some trailing whitespace in here.
  • I prefer reference-style links 1.

I'm concerned about having both lesson-template-oriented content (“If
you're looking for things to work on, please see the current list of
issues”) and stuff setting up for downstream lessons (“This lesson is
based on the template…”). Do we want to make that distinction more
obvious, so template contributors don't get confused and downstream
lesson maintainers know what to tweak?

@@ -0,0 +1,42 @@
---
layout: page
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this YAML header? I thought that CONTRIBUTING.md is like README.md or FAQ.md.

1.  Removed YAML header.
2.  Changed link to refer to `LICENSE.html` instead of `LICENSE.md`.

Leaving the reference to the lesson-template repo alone - lesson authors will be expected to edit this (and instructions to do that will go in the docs in the gh-pages branch).
gvwilson pushed a commit that referenced this pull request Feb 13, 2015
@gvwilson gvwilson merged commit eaf4348 into swcarpentry:core Feb 13, 2015
@gvwilson gvwilson deleted the adding-contributing branch February 13, 2015 14:36
@gvwilson gvwilson assigned rgaiacs and unassigned ChristinaLK Feb 13, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants