From 44ba4339e3fed56655c24f59b2dd83492de80afc Mon Sep 17 00:00:00 2001 From: Junichi Sato <22004610+sato11@users.noreply.github.com> Date: Thu, 12 Jan 2023 12:21:10 +0900 Subject: [PATCH] `bundle install` with `--with` and `--binstubs` flags has been deprecated Following the getting started in CONTRIBUTING.md outputs deprecation messages: ``` [DEPRECATED] The `--with` flag is deprecated because it relies on being remembered across bundler invocations, which bundler will no longer do in future versions. Instead please use `bundle config set --local with 'test sidekiq'`, and stop using this flag [DEPRECATED] The --binstubs option will be removed in favor of `bundle binstubs --all` ``` This commit updates the section accordingly. Also, since it encourages to generate binstubs, incentivize using bin/* over bundle exec in development. --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cde1cdf01..3fcce7806 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,12 +17,14 @@ Thank you! * Install the test dependencies ``` - bundle install --with test sidekiq --binstubs + bundle config set --local with 'test sidekiq' + bundle install + bundle binstubs --all ``` * Run the tests with and make sure they all pass ``` - bundle exec rake + bin/rake ``` * Further information on installing and running the tests can be found in [the testing guide](TESTING.md) @@ -32,7 +34,7 @@ Thank you! * Write API docs for your contributions using [YARD](https://yardoc.org/) * Generate the API documentation locally ``` - bundle exec rake yard + bin/rake yard ``` * Review your changes by opening `doc/index.html`