From bfac77c328c873e988ecaf43fe6b7e60c048c80d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Csavka2017=E2=80=9D?= Date: Mon, 27 Nov 2023 14:01:54 +0200 Subject: [PATCH 1/2] update readme --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ README.md | 12 +++++------- json_logic.gemspec | 3 ++- 3 files changed, 43 insertions(+), 8 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b6b0dec --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing + +We love pull requests from everyone. By participating in this project, you +agree to abide by the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) + +Fork, then clone the repo: + + git clone git@github.com:your-username/json_logic_ruby.git + +Set up your machine: + + bundle install + +Make sure the tests pass: + + rspec + +Make your change. Add tests for your change. Make the tests pass: + + rspec + +Push to your fork and [submit a pull request][pr]. + +[pr]: https://github.com/useful-libs/json_logic_ruby/compare/ + +At this point you're waiting on us. We like to at least comment on pull requests +within three business days (and, typically, one business day). We may suggest +some changes or improvements or alternatives. + +Some things that will increase the chance that your pull request is accepted: + +* Write tests. +* Write a [good commit message][commit], using also [release-please approach][release-please] + +[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[release-please]: https://github.com/googleapis/release-please diff --git a/README.md b/README.md index fd5c962..bbee490 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ Build rules and execute them in ruby. See https://jsonlogic.com Install the gem and add to the application's Gemfile by executing: - $ bundle add json_logic + $ bundle add json_logic_ruby If bundler is not being used to manage dependencies, install the gem by executing: - $ gem install json_logic + $ gem install json_logic_ruby ## Usage #### Run json-logic: @@ -55,13 +55,11 @@ puts logic.tracker.report ## Development -After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). +After checking out the repo, run `bundle install` to install dependencies. ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/useful-libs/json-logic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/useful-libs/json-logic/blob/main/CODE_OF_CONDUCT.md). +Please see [CONTRIBUTING.md](CONTRIBUTING.md). ## License @@ -69,4 +67,4 @@ The gem is available as open source under the terms of the [MIT License](https:/ ## Code of Conduct -Everyone interacting in the Json::Logic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/useful-libs/json-logic/blob/master/CODE_OF_CONDUCT.md). +Everyone interacting in the Json::Logic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/useful-libs/json_logic_ruby/blob/main/CODE_OF_CONDUCT.md). diff --git a/json_logic.gemspec b/json_logic.gemspec index 17b7b94..dc8a3db 100644 --- a/json_logic.gemspec +++ b/json_logic.gemspec @@ -6,10 +6,11 @@ Gem::Specification.new do |spec| spec.name = 'json_logic_ruby' spec.version = JsonLogic::VERSION spec.authors = ['Volodymyr Stashchenko', 'Andriy Savka'] + spec.email = %w[stashchenko@ukr.net savka.ai2015@gmail.com] spec.summary = 'Build complex rules, serialize them as JSON, and execute them in ruby.' spec.description = 'Build complex rules, serialize them as JSON, and execute them in ruby. See https://jsonlogic.com' - spec.homepage = 'https://github.com/useful-libs/json_logic' + spec.homepage = 'https://github.com/useful-libs/json_logic_ruby' spec.license = 'MIT' spec.required_ruby_version = '>= 3.2.0' From 297faaee02a8151e71c64fe3573236e53c736b02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Csavka2017=E2=80=9D?= Date: Mon, 27 Nov 2023 16:08:33 +0200 Subject: [PATCH 2/2] add TargetRubyVersion --- .rubocop.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.rubocop.yml b/.rubocop.yml index 60206e8..ff745eb 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -4,6 +4,7 @@ require: AllCops: SuggestExtensions: true NewCops: enable + TargetRubyVersion: 3.2 Metrics/BlockLength: Exclude: