Thank you for considering contributing to Rack::Attack.
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct.
Any of the following is greatly appreciated:
- Helping users by answering to their questions
- Helping users troubleshoot their error reports to figure out if the error is caused by an actual bug or some misconfiguration
- Giving feedback by commenting in other users feature requests
- Reporting an error you are experiencing
- Suggesting a new feature you think it would be useful for many users
- If you want to work on fixing an actual issue and you don't know where to start, those labeled good first issue may be a good choice
As an effort to keep the codebase consistent, we encourage the use of Rubocop. This tool helps us abstract most of the decisions we have to make when coding.
To check your code, simply type bundle exec rubocop in the shell. The resulting output are all the offenses currently present in the code.
It is highly recommended that you integrate a linter with your editor. This way you receive real time feedback about your code. Most editors have some kind of plugin for that.