diff --git a/.github/contributing.md b/.github/contributing.md index 048890be..dffd847a 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -17,6 +17,21 @@ fix or new functionality. Functionality must meet my design goals and vision for the project to be accepted; I would be happy to discuss how your idea can best fit into Sidekiq. +### Local development setup + +You need Redis installed and a Ruby version that fulfills the requirements in +`sidekiq.gemspec`. Then: + +``` +bundle install +``` + +And in order to run the tests and linter checks: + +``` +bundle exec rake +``` + ## Legal By submitting a Pull Request, you disavow any rights or claims to any changes diff --git a/README.md b/README.md index f28765ac..0acf8f59 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,11 @@ Useful resources: Every Friday morning is Sidekiq happy hour: I video chat and answer questions. See the [Sidekiq support page](https://sidekiq.org/support.html) for details. +Contributing +----------------- + +Please see [the contributing guidelines](https://github.com/mperham/sidekiq/blob/main/.github/contributing.md). + License -----------------