rails icon indicating copy to clipboard operation
rails copied to clipboard

[ci-skip] Improve error-reporting guide

Open shalvah opened this issue 2 years ago • 0 comments

Motivation / Background

This PR makes some improvements to the error-reporting guide introduced in https://github.com/rails/rails/pull/45946 :

  • Reworks the docs for clarity
  • Removes some unnecessary content
  • Adds some missing details

I work with Honeybadger, and we recently added support for the error reporter, so I also went ahead to mention us as an example of tools which support it.

Checklist

Before submitting the PR make sure the following are checked:

  • [x] This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • [x] There are no typos in commit messages and comments.
  • [x] Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • [x] Feature branch is up-to-date with main (if not - rebase it).
  • [x] Pull request only contains one commit for bug fixes and small features. If it's a larger feature, multiple commits are permitted but must be descriptive.
  • [x] Tests are added if you fix a bug or add a feature.
  • [x] CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.
  • [x] PR is not in a draft state.
  • [x] CI is passing.

shalvah avatar Sep 21 '22 23:09 shalvah