Sha256: a93eb4d0b632e94dccb6cddd00240f054b964db3df3895ec99b495a966087ba9
Contents?: true
Size: 1.99 KB
Versions: 10
Compression:
Stored size: 1.99 KB
Contents
# Contributing to airbrussh Have a feature idea, bug fix, or refactoring suggestion? Contributions are welcome! ## Pull requests 1. Check [Issues][] to see if your contribution has already been discussed and/or implemented. 2. If not, open an issue to discuss your contribution. I won't accept all changes and do not want to waste your time. 3. Once you have the :thumbsup:, fork the repo, make your changes, and open a PR. 4. Don't forget to add your contribution and credit yourself in `CHANGELOG.md`! ## Coding guidelines * This project has a coding style enforced by [RuboCop][]. Use hash rockets and double-quoted strings, and otherwise try to follow the [Ruby style guide][style]. * Writing tests is strongly encouraged! This project uses Minitest. ## Getting started Note that Bundler 1.10 is required for development. Run `gem update bundler` to get the latest version. After checking out the airbrussh repo, run `bin/setup` to install dependencies. Run `rake` to execute airbrussh's tests and RuboCop checks. Airbrussh is designed to work against multiple versions of SSHKit and Ruby. In order to test this, we use the environment variable `sshkit` in order to run the tests against a specific version. The combinations of sshkit and ruby we support are specified in [.travis.yml](.travis.yml). To test all the versions locally, there is a `test_all.rb` bin file. This installs the gems and runs the tests for each sshkit version in [.travis.yml](.travis.yml). *Note: this will update your `Gemfile.lock` as each SSHKit gem version is installed. The gem version is restored to the default when the script exits.* A Guardfile is also present, so if you'd like to use Guard to do a TDD workflow, then: 1. Run `bundle install --with extras` to get the optional guard dependencies 2. Run `guard` to monitor the filesystem and automatically run tests as you work [Issues]: https://github.com/mattbrictson/airbrussh/issues [RuboCop]: https://github.com/bbatsov/rubocop [style]: https://github.com/bbatsov/ruby-style-guide
Version data entries
10 entries across 10 versions & 1 rubygems