diff --git a/.gitignore b/.gitignore index 2a24c716..91b78552 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,20 @@ +*.gem +*.rbc +.bundle +.config .devnotes .greenbar +.yardoc Gemfile.lock -coverage/ -.yardoc/ +InstalledFiles +_yardoc +coverage doc/ -*.gem -.bundle +lib/bundler/man +pkg +rdoc +spec/reports +test/tmp +test/version_tmp +tmp +bin \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e18bdc37 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +## Contributing +In the spirit of [free software][free-sw], **everyone** is encouraged to help +improve this project. + +[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html + +Here are some ways *you* can contribute: + +* by using alpha, beta, and prerelease versions +* by reporting bugs +* by suggesting new features +* by writing or editing documentation +* by writing specifications +* by writing code (**no patch is too small**: fix typos, add comments, clean up + inconsistent whitespace) +* by refactoring code +* by closing [issues][] +* by reviewing patches + +[issues]: https://github.com/lotus/view/issues + +## Submitting an Issue +We use the [GitHub issue tracker][issues] to track bugs and features. Before +submitting a bug report or feature request, check to make sure it hasn't +already been submitted. When submitting a bug report, please include a [Gist][] +that includes a stack trace and any details that may be necessary to reproduce +the bug, including your gem version, Ruby version, and operating system. +Ideally, a bug report should include a pull request with failing specs. + +[gist]: https://gist.github.com/ + +## Submitting a Pull Request +1. [Fork the repository.][fork] +2. [Create a topic branch.][branch] +3. Add specs for your unimplemented feature or bug fix. +4. Run `bundle exec rake`. If your specs pass, return to step 3. +5. Implement your feature or bug fix. +6. Run `bundle exec rake`. If your specs fail, return to step 5. +7. Add, commit, and push your changes. +8. [Submit a pull request.][pr] + +[fork]: http://help.github.com/fork-a-repo/ +[branch]: http://learn.github.com/p/branching.html +[pr]: http://help.github.com/send-pull-requests/ diff --git a/Gemfile b/Gemfile index e5c0e14b..0e547baa 100644 --- a/Gemfile +++ b/Gemfile @@ -1,10 +1,10 @@ source 'https://rubygems.org' gemspec -if !ENV['TRAVIS'] +unless ENV['TRAVIS'] gem 'byebug', require: false, platforms: :ruby if RUBY_VERSION == '2.1.1' gem 'yard', require: false - gem 'lotus-utils', require: false, path: '../lotus-utils' + gem 'lotus-utils', require: false, github: 'lotus/utils' else gem 'lotus-utils' end diff --git a/LICENSE.txt b/LICENSE.md similarity index 100% rename from LICENSE.txt rename to LICENSE.md