Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.56 KB
Raw

Elephant Field Guide :: Contributing

Contributions are welcome. All changes must be submitted via pull request.

Guidelines

  • Changes to the content and structure of the guide should be submitted separately. The main exception to this is when submitting adding a new data field.
  • Unrelated changes (e.g. changes to multiple elephpants) should be submitted as separate pull requests.
  • New content must have a verifiable source.
  • By submitting a pull request you are agreeing to license your contribution by the same license as the rest of the guide (currently CC:BY-NC-SA).

Style Guide

  • Use spaces for indenting.
  • Use Unix line endings (LF).
  • Use a soft limit of 80 characters and a hard limit of 120 characters per line.

Elephants

  • Only "official" Elephpants are included.
  • Elephpants are defined, one per file, in the source/_elephpants directory.
  • The file name is of the structure DATE-COLOR-IDENTIFIER.md, where DATE is the date of public release, or public announcement (if earlier).
  • Alternative animals are defined in source/_other following the same structure.
  • When describing a new subspecies, a common name and subspecies name must also be added to app/config/sculpin_site.yml.

Images

  • All photos used must be covered by a Creative Commons licensed that allows re-use.
  • As-of 2016-02-22, photos are stored locally from the source/photos directory.
  • Photos should be cropped to 400 by 300 pixels.
  • Preferably photos will link to a page with a full-resolution copy of the photo.