Skip to content

Commit

Permalink
Merge pull request #51 from viralpraxis/actualize-readme
Browse files Browse the repository at this point in the history
Actualize README.md
  • Loading branch information
viralpraxis authored Sep 20, 2024
2 parents 5984822 + 74b4685 commit bfb6182
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# RuboCop::ThreadSafety

Thread-safety analysis for your projects, as an extension to
[RuboCop](https://github.com/bbatsov/rubocop).
[RuboCop](https://github.com/rubocop/rubocop).

## Installation and Usage

Expand Down Expand Up @@ -60,6 +60,8 @@ Improvements that would make shared state thread-safe include:
* Use [`RequestStore`](https://github.com/steveklabnik/request_store)
* Use `Thread.current[:name]`

Certain system calls, such as `chdir`, affect the entire process. To avoid potential thread-safety issues, it's preferable to use (if possible) the `chdir` option in methods like `Kernel.system` and `IO.popen` rather than relying on `Dir.chdir`.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand Down

0 comments on commit bfb6182

Please sign in to comment.