From 0a80e30f4685e5534042589b4fc990549d8d797a Mon Sep 17 00:00:00 2001 From: Gonzalo Date: Mon, 27 Jan 2020 16:00:31 -0300 Subject: [PATCH] docs: help users write more clear bug reports with a template --- .github/ISSUE_TEMPLATE/bug_report.md | 46 ++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..00bcd47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,46 @@ +**Describe the bug** + +A clear and concise description of what the bug is. + +**To Reproduce** + +Steps to reproduce the behavior: + +1. Have a rack-attack config as follows: + +```ruby + # E.g. + + Rack::Attack.cache.store = " ... " + + Rack::Attack.throttle(... + + # And so on + +``` + +2. Start the app server +3. Visit the page with path '....' +4. See error + +**Expected behavior** + +A clear and concise description of what you expected to happen. + +**Screenshots** + +If applicable, add screenshots to help explain your problem. + +**Environment information (please complete the following information):** + + - rack-attack version: + - ruby version: + - rack version: + - rails version (if using rails): + - rails environment (if using rails): [e.g. development, production, all] + - redis gem version (if reporting redis-related issue): + - redis server version (if reporting redis-related issue): + +**Additional context** + +Add any other context about the problem you think can help here.