ruby_checker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e79f1172a7f16cc5fd768291aeaaa80b9cfee2928703dfd167239d05c3733c78
+  data.tar.gz: ec39b7b666d51613774dc7572f98f569c5a625351f5209827ca191154bcdf213
+SHA512:
+  metadata.gz: 460ecd9775931511690147038ad1460a6c471acff771869c9f8763925c03d53877d1cb8de42564b0cbc1c179f8fa2e393f88772faf79abcbb270e6a34f4bb684
+  data.tar.gz: 8dd18f8fe5c019dbdf42ec586ece3fe631fe0313ae49e3cbf78e9e6fca2b355f6da9b3c2fdbef6716e7fb0fc3b812e4f4b05e2a2cc880d2e9698468c5b36ec11

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 1.0.0
+
+- Implemented the basic functionality of `ruby_checker`:
+  - Detection of ruby version and raising exceptions on certain scenarios.
+  - Detection of ruby interpreter and raising exceptions on certain scenarios.

data/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing to ruby_checker
+
+## Running tests
+
+First of all, make sure that you have all the dependencies. In order to do that,
+simply run:
+
+```bash
+$ bundle
+```
+
+After that, running tests is as easy as doing the following:
+
+```bash
+$ rake
+```
+
+Unit tests are located inside of the `tests` directory and they are using
+[minitest](https://github.com/seattlerb/minitest).
+
+Note that this will also run other checkers. More on that later.
+
+### Checking the style
+
+This project uses [rubocop](https://github.com/rubocop-hq/rubocop) in order to
+check the style of the Ruby code. So, in order to check the style just run:
+
+```bash
+$ bundle exec rubocop
+```
+
+And you can also run it like this:
+
+```bash
+$ rake rubocop
+```
+
+### Git validation
+
+In order to ensure that the git log is as maintainable as possible, the
+[git-validation](https://github.com/vbatts/git-validation) tool is used. You can
+install this tool by running:
+
+```bash
+$ go get -u github.com/vbatts/git-validation
+```
+
+If you already have this tool installed, then simply perform:
+
+```bash
+$ rake git-validation
+```
+
+Note that if you don't have this tool installed the task will do nothing (it
+will just print a help message). This is done so when running the default make
+task this doesn't interrupt it.
+
+## Issue reporting
+
+I'm using [Github](https://github.com/mssola/ruby_checker) in order to host the
+code. Thus, in order to report issues you can do it on its [issue
+tracker](https://github.com/mssola/ruby_checker/issues). A couple of notes on
+reports:
+
+- Check that the issue has not already been reported or fixed in `master`.
+- Try to be concise and precise in your description of the problem.
+- Provide a step by step guide on how to reproduce this problem.
+- Provide the version you are using (the commit SHA, if possible), and the
+version of related dependencies, as well as the version of the GNU Emacs you are
+using and the operating system.
+
+## Pull requests
+
+- Write a [good commit message](https://chris.beams.io/posts/git-commit/).
+- Make sure that tests are passing on your local machine (it will also be
+checked by the CI system whenever you submit the pull request).
+- Update the [changelog](./CHANGELOG.md).
+- Try to use the same coding conventions as used in this project.
+- Open a pull request with *only* one subject and a clear title and
+description. Refrain from submitting pull requests with tons of different
+unrelated commits.