Skip to content

Commit

Permalink
Add contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
Kikobeats committed Aug 30, 2016
1 parent 6b52647 commit 1fb3d66
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 3 deletions.
2 changes: 1 addition & 1 deletion assets/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Table of contents

* [JS MythBusters_](/README.md)
* [Send your tip!](/send-tip.md)
* [Send your tip!](/contributing.md)
* [Bibliography](/bibliography.md)
* [Resources](/resources.md)

Expand Down
2 changes: 1 addition & 1 deletion assets/scss/_markdown.scss
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ html .markdown-body table th {
font-size: x-large;
}

a.link.title.link-send-tip {
a.link.title.link-contributing {
color: $special-text-color !important;
}

Expand Down
12 changes: 12 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Send your tip!

For submit a tip, do a PR in our [GitHub repository](https://github.com/Kikobeats/js-mythbusters).

Before add your tip take in consideration the following guidelines:

- Add your tip in the correct section. Each different section is a folder (for example [v8-tips](https://github.com/Kikobeats/js-mythbusters/tree/master/v8-tips) or [workflow](https://github.com/Kikobeats/js-mythbusters/tree/master/workflow)).
- Inside the folder, each file is a tip.
- If your tip is very similar to a tip that already exists, consider extend the first tip.
- Don't add more than one tip per file.
- The text that describe the tip have to be concesive and precise.
- For avoid extend the tip, you can reference other tips of the site.
1 change: 0 additions & 1 deletion send-tip.md

This file was deleted.

0 comments on commit 1fb3d66

Please sign in to comment.