Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skateman/zimdel

A GitHub auto-reply bot for mentioning
https://github.com/skateman/zimdel

bot github mention ruby

Last synced: about 2 months ago
JSON representation

A GitHub auto-reply bot for mentioning

Awesome Lists containing this project

README

        

# Zimdel

Zimdel is a simple auto-reply bot for GitHub, it is triggered by mentioning.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'zimdel'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install zimdel

## Usage

To start the bot, you will need a configuration file. All the available configuration options are specified in the `config_sample.yml`.

```ruby
zimdel -c config.yml
```

## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zimdel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

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