diff --git a/.hound.yml b/.hound.yml new file mode 120000 index 0000000..62a9e6e --- /dev/null +++ b/.hound.yml @@ -0,0 +1 @@ +.rubocop.yml \ No newline at end of file diff --git a/.rubocop.yml b/.rubocop.yml new file mode 100644 index 0000000..9df0b45 --- /dev/null +++ b/.rubocop.yml @@ -0,0 +1,20 @@ +Metrics/LineLength: + Enabled: false + +Style/EachWithObject: + Enabled: false + +Style/Encoding: + EnforcedStyle: when_needed + +Style/FormatString: + Enabled: false + +Style/HashSyntax: + EnforcedStyle: hash_rockets + +Style/SignalException: + EnforcedStyle: only_raise + +Style/StringLiterals: + EnforcedStyle: double_quotes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4a694fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +## Getting Involved + +New contributors are always welcome, when it doubt please ask questions. We strive to be an open and welcoming community. Please be nice to one another. + +### Coding + +* Pick a task: + * Offer feedback on open [pull requests](https://github.com/plribeiro3000/jazz_fingers/pulls). + * Review open [issues](https://github.com/plribeiro3000/jazz_fingers/issues) for things to help on. + * [Create an issue](https://github.com/plribeiro3000/jazz_fingers/issues/new) to start a discussion on additions or features. +* Fork the project, add your changes and tests to cover them in a topic branch. +* Commit your changes and rebase against `plribeiro3000/jazz_fingers` to ensure everything is up to date. +* [Submit a pull request](https://github.com/plribeiro3000/jazz_fingers/compare/) + +### Non-Coding + +* Offer feedback on open [issues](https://github.com/plribeiro3000/jazz_fingers/issues). +* Organize or volunteer at events. \ No newline at end of file diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..d910e79 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,9 @@ +# Original Author +* Gopal Patel + +# Contributors +* Andrew Volozhanin +* Casey Lang +* Fernando Paredes +* Micah Gates +* Paulo Henrique Lopes Ribeiro diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..a1fbdc1 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2014-2015 [CONTRIBUTORS.md](https://github.com/plribeiro3000/jazz_fingers/blob/master/CONTRIBUTORS.md) + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 3cdcb34..8e345d7 100644 --- a/README.md +++ b/README.md @@ -66,11 +66,6 @@ Separator string between the application name and line input. Defaults to `ยป` for GNU readline or libedit. Defaults to `>` for `rb-readline` which fails on mixed encodings. -## Contributing - -Patches and bug reports are welcome. Just send a [pull request][pullrequests] or -file an [issue][issues]. [Project changelog][changelog]. - [pry]: http://pry.github.com [awesome_print]: https://github.com/michaeldv/awesome_print