Skip to content

Commit

Permalink
Merge pull request #1 from hwayne/hwayne-patch-1
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md
  • Loading branch information
hwayne authored Dec 27, 2017
2 parents 2d3482d + ad0be56 commit 77f6080
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,33 @@

# Contribution Guidelines

## Adding to this List

All submissions should have the following format:

* **Title:** [Title of thing, with link to thing](https://www.youtube.com/watch?v=JWOY6uu3VUo)
* **Title:** [Title of thing, with link to thing](https://www.youtube.com/watch?v=JWOY6uu3VUo) (PDF/Video/etc tag, optional)

* **Hype:** "The hyped claim or topic being addressed. You can be informal here, but don't be snide."

* **Shower:** The counter-claim, specified well. It should explain why this thing is rigorous enough for inclusion. For example, it has benchmarks, it carefully dissects the claim, it cites research, etc.

* **Caveats:** Any limitations to the thing. For example, it's old, it doesn't address a specific part of a claim, it has threats to validity, etc.

* **Notes:** Anything else you think is important to include.
* **Notes:** Anything else you think is important to include. (Optional)

If any of this seems unclear to you, check out the existing list for examples of what it should look like. Here's a copyable template without formatting:

```
* **Title:**
* **Hype:**
* **Shower:**
* **Caveats:**
* **Notes:**
```

If any of this seems unclear to you, check out the existing list for examples of what it should look like.

Expand Down

0 comments on commit 77f6080

Please sign in to comment.