Add a note about caching and docker to the readme #1233
+11
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By default the RuboCop cache directory is inside a users home directory (cache path docs).
When developing inside docker this path isn't persisted by default, meaning that when invocing rubocop inside the docker container the cache is discarded every time.
In the context of a Rails application there already exists a directory that the user should be persisting (either through a volume or just by mounting it in from the host), the
tmp
directory in the Rails application root. This folder contains, among other things, development secrets which should be persisted across runs so that things like sessions are still valid after a container restart.I originally wanted to make this part of the default config but I realized that this gem isn't specific to Rails applications. So I think a mention in the readme will do instead.
Before submitting the PR make sure the following are checked:
[Fix #issue-number]
(if the related issue exists).master
(if not - rebase it).bundle exec rake default
. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.md
if the new code introduces user-observable changes. See changelog entry format for details.