Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ require:
AllCops:
SuggestExtensions: true
NewCops: enable
TargetRubyVersion: 3.2

Metrics/BlockLength:
Exclude:
Expand Down
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -55,18 +55,16 @@ 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

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## 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).
3 changes: 2 additions & 1 deletion json_logic.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down