README.md in thinreports-0.10.3 vs README.md in thinreports-0.11.0
- old
+ new
@@ -1,9 +1,9 @@
# Thinreports Generator
[](http://badge.fury.io/rb/thinreports)
-[](http://travis-ci.org/thinreports/thinreports-generator)
+[](https://github.com/thinreports/thinreports-generator/actions)
[](https://codeclimate.com/github/thinreports/thinreports-generator/maintainability)
[Thinreports](http://www.thinreports.org) is an open source report generating tool for Ruby.
* Thinreports Editor (GUI Designer)
@@ -12,17 +12,16 @@
## Getting Started
* [Installation Guide](http://www.thinreports.org/documentation/getting-started/installation.html)
* [Quick Start Guide](http://www.thinreports.org/documentation/getting-started/quickstart.html)
* [Examples](https://github.com/thinreports/thinreports-examples)
- * [Rails5 Example](https://github.com/thinreports/thinreports-rails5-example)
* [Changelog](https://github.com/thinreports/thinreports-generator/blob/master/CHANGELOG.md)
* [Discussion Group](https://groups.google.com/forum/#!forum/thinreports)
## Supported versions
- * Ruby 2.1, 2.2, 2.3, 2.4, 2.5
+ * Ruby 2.4, 2.5, 2.6, 2.7
* JRuby 9.2
## Quick Reference
**NOTE:** You need to create a layout file `.tlf` using [Thinreports Editor](http://www.thinreports.org/features/editor/).
@@ -259,22 +258,47 @@
* External characters (Gaiji) for Japanese
## Contributing
-### Report bug, post your suggestion
+Bug reports and pull requests are welcome on GitHub at https://github.com/thinreports/thinreports-generator.
-If you find bugs or improvements for the Editor, please report it [here](https://github.com/thinreports/thinreports-generator/issues/new).
+## Development
-### Sending a Pull Request
+### How to run feature tests
- 1. Fork it
- 2. Clone your forked repository
- 3. Create your feature branch: `git checkout -b my-new-feature`
- 4. Fix your feature
- 5. Commit your changes: `git commit -am 'Fixed some bugs or features'`
- 6. Push to the branch: `git push origin my-new-feature`
- 7. Create new Pull Request
+```
+$ bundle exec rake test:features
+```
+
+In order to run `test:features`, you need to install [diff-pdf](https://github.com/vslavik/diff-pdf) in your environment, or you can run test in the docker container as below.
+
+### How to develop in Docker container
+
+You can use the Docker container for development. This container contains the libraries required for testing, such as diff-pdf.
+
+```
+$ docker build -t thinreports-dev .
+$ docker run -v $PWD:/thinreports:cached -it thinreports-dev bash
+
+> /thinreports#
+```
+
+You can run test:
+
+```
+> /thinreports# bundle install
+> /thinreports# bundle exec rake test:features
+```
+
+## Releasing Generator
+
+1. Update the version number in `version.rb`
+2. Update `CHANGELOG.md` and `README.md` (if needed)
+3. Create the Release PR like #105
+4. Merge the PR
+5. Is the master CI green? If not, make it green
+6. 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
## License
Thinreports Generator is licensed under the [MIT-License](https://github.com/thinreports/thinreports-generator/blob/master/MIT-LICENSE).