Permalink
Browse files

Update from talk-template and node-template

  • Loading branch information...
Jeffrey Horn
Jeffrey Horn committed Oct 7, 2016
1 parent 57816f5 commit 73b807d2965b6db6ed3d21d94c00aa6363c0a229
Showing with 28 additions and 0 deletions.
  1. +12 −0 CONTRIBUTING.md
  2. +16 −0 STYLE.md
@@ -0,0 +1,12 @@
# Contributing

If you would like to contribute, please follow the [style guide](STYLE.md).
Issues labeled ["help
wanted"](https://github.com/ga-wdi-boston/meta/labels/help%20wanted) are a good
place to start!

To contribute, clone this repository. If you don't have commit access: fork,
clone, then pull request.

Feel free to comment on any issue, including proposed changes. If you have any
questions or want to discuss a new change, don't hesitate to file an issue.
@@ -0,0 +1,16 @@
# Style Guide

## Markdown

Use [remark-lint](https://github.com/wooorm/remark-lint). There's a nice [plugin
for Atom](https://atom.io/packages/linter-markdown). Have a look at the [default
style rules](https://github.com/wooorm/remark-lint/blob/master/doc/rules.md) and
our own [.remarkrc](.remarkrc) for non-default configuration options. These
rules are selected for readability of source code compatibility with GitHub
wiki features.

### HTML

Please refrain from using HTML inside markdown files, as a rule. Sometimes,
using HTML is the only way to accomplish something, like including an image with
a custom width attribute.

0 comments on commit 73b807d

Please sign in to comment.