Skip to content

Commit

Permalink
Updated the contributing guidelines.
Browse files Browse the repository at this point in the history
  • Loading branch information
arbox committed Jan 27, 2017
1 parent 912a7ca commit d366c34
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -26,7 +26,9 @@ Please ensure your pull request adheres to the following guidelines:

- Make an individual pull request for each suggestion.
- Use the following format: `- [title](link) - Description.`
Note the capitalization and punctuation.
Note the capitalization and punctuation. Name the tools and libraries exactly
how they are required from the Ruby programs, not after the Readme's title, e.g.
`treat`, not `Treat`, since you do `require "treat"`.
- Link additions should be added to the bottom of the relevant category.
- New categories or improvements to the existing categorization are welcome.
- Check your spelling and grammar.
Expand Down
6 changes: 6 additions & 0 deletions FAQ.md
Expand Up @@ -38,3 +38,9 @@ The answer is simple and sounds "NO". Not in pure Ruby. But you can be very
efficient and use Ruby bindings for Java, C and C++ based libraries.
And sometimes buying newer hardware can be cheaper than writing everything in
C++. It's definitely your choice!

## How do you call list items?

Every library list item has the naming after the Ruby library. The name is
the exact wording of the `require` statement to facilitate search and
memoization. That's why it is called `treat` and not `Treat`.

0 comments on commit d366c34

Please sign in to comment.