Skip to content

Commit

Permalink
rake console changes - description and contributing.md (faker-ruby#1288)
Browse files Browse the repository at this point in the history
* bin/console for IRB with gem files loaded

* Add info about rake console task to CONTRIBUTING.md and a task description

* Update Rakefile

* Update CHANGELOG.md
  • Loading branch information
MarcPer authored and vbrazo committed Jun 20, 2018
1 parent 13b367a commit b9fd393
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
- [PR #900](https://github.com/stympy/faker/pull/900) Add Japanese lorem words to locale [@vietqhoang](https://github.com/vietqhoang)

### Update/add locales
- [PR #616](https://github.com/stympy/faker/pull/616) add german commerce translations [@weh](https://github.com/weh)
- [PR #1281](https://github.com/stympy/faker/pull/1281) Some competitions were in the coaches array [@Eusebiotrigo](https://github.com/Eusebiotrigo)
- [PR #1103](https://github.com/stympy/faker/pull/1103) Fix inconsistent capitalization in dishes, ingredients and spices, and some other small issues under 'food' [@evrimfeyyaz](https://github.com/evrimfeyyaz)
- [PR #1262](https://github.com/stympy/faker/pull/1262) Add fr_CH locale [@elentras](https://github.com/elentras)
Expand Down Expand Up @@ -100,7 +101,8 @@
- [PR #1173](https://github.com/stympy/faker/pull/1173) Fix tests warning [@vbrazo](https://github.com/vbrazo)

### Chores
- [PR #719](https://github.com/stympy/faker/pull/719) Random words to add should be 0 [@swapsCAPS](https://github.com/swapsCAPS)
- [PR #1288](https://github.com/stympy/faker/pull/1288) rake console changes - description and contributing.md [@MarcPer](https://github.com/MarcPer)
- [PR #1283](https://github.com/stympy/faker/pull/1283) Add Faker::Military [@jjasghar](https://github.com/jjasghar)

### Documentation
- [PR #1121](https://github.com/stympy/faker/pull/1121) Better docs for Faker::Food.description [@jujulisan](https://github.com/jujulisan)
Expand Down
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ If you want to try to fix the rubocop violations, you should run `bundle exec ru

If you are not familiar with Rubocop, spend some time studying their page and a few study cases on the internet.

4. Please add a test for your change. Only refactoring and documentation changes
require no new tests. If you are adding functionality or fixing a bug, we need
a test! We use [Minitest](https://github.com/seattlerb/minitest) in this project. If you're not familiar with Minitest and are comfortable with Rspec, please ask a contributor/collaborator to review your PR.
4. Please add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test! We use [Minitest](https://github.com/seattlerb/minitest) in this project. If you're not familiar with Minitest and are comfortable with Rspec, please ask a contributor/collaborator to review your PR.

5. Make the test pass. Always use `sample`, `shuffle`, and `rand` from
the Base class (just like the rest of the code) rather than
Expand Down Expand Up @@ -66,3 +64,7 @@ If you're reviewing a PR, you should ask youserlf:
* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or `my_method my_arg`.
* `a = b` and not `a=b`.
* Follow the conventions you see used in the source already.

### Tips

* Use the `rake console` task to start a session with Faker loaded.
1 change: 1 addition & 0 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Dir['tasks/**/*.rake'].each { |rake| load rake }
require 'bundler'
Bundler::GemHelper.install_tasks

desc 'Start a console session with Faker loaded'
task :console do
require 'irb'
require 'irb/completion'
Expand Down

0 comments on commit b9fd393

Please sign in to comment.