CONTRIBUTING.md

   1 Contributing Boot Camp Material
   2 ===============================
   3
   4 Licenses
   5 --------
   6
   7 See http://software-carpentry.org/license.html for the licenses covering
   8 Software Carpentry material. By contributing you are agreeing that
   9 Software Carpentry may redistribute your work under these licenses.
  10
  11 Workflow
  12 --------
  13
  14 Software Carpentry uses a development workflow similar to that of
  15 [AstroPy][] and many other open source projects. The AstroPy docs have
  16 excellent sections on:
  17
  18 * [Getting started with git][astropy-git]
  19 * [Developer workflow][astropy-workflow]
  20
  21 File Formats
  22 ------------
  23
  24 ### Text
  25
  26 Text documents should be in [Markdown][] format and compatible
  27 with [Redcarpet][], the engine GitHub uses to render Markdown.
  28
  29 ### Slides
  30
  31 The preferred format for slide presentations is still to be determined.
  32
  33 [AstroPy]: http://astropy.org
  34 [astropy-git]: http://astropy.readthedocs.org/en/latest/development/workflow/index.html#getting-started-with-git
  35 [astropy-workflow]: http://astropy.readthedocs.org/en/latest/development/workflow/development_workflow.html
  36 [Markdown]: http://daringfireball.net/projects/markdown/
  37 [Redcarpet]: https://github.com/vmg/redcarpet