From 1bb354e96d88ab8ebe6a5a538ff48d511004da9f Mon Sep 17 00:00:00 2001 From: David Baker Date: Thu, 26 Jan 2023 15:43:02 +0000 Subject: [PATCH] Document the decoder ring (#24317) * Document the decoder ring Also a few little tidy-ups. * Prettier --- CONTRIBUTING.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ca195b9a6..fd3ef7d63b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,6 @@ ask you to make any refinements needed or merge it and make them ourselves. Things that should go into your PR description: -- A changelog entry in the `Notes` section (see below) - References to any bugs fixed by the change (in GitHub's `Fixes` notation) - Describe the why and what is changing in the PR description so it's easy for onlookers and reviewers to onboard and context switch. This information is @@ -41,11 +40,14 @@ Things that should go into your PR description: - Add comments to the diff for the reviewer that might help them to understand why the change is necessary or how they might better understand and review it. -We rely on information in pull request to populate the information that goes into -the changelogs our users see, both for Element Web itself and other projects on -which it is based. This is picked up from both labels on the pull request and -the `Notes:` annotation in the description. By default, the PR title will be -used for the changelog entry, but you can specify more options, as follows. +### Changelogs + +There's no need to manually add Changelog entries: we use information in the +pull request to populate the information that goes into the changelogs our +users see, both for Element Web itself and other projects on which it is based. +This is picked up from both labels on the pull request and the `Notes:` +annotation in the description. By default, the PR title will be used for the +changelog entry, but you can specify more options, as follows. To add a longer, more detailed description of the change for the changelog: @@ -280,3 +282,10 @@ When stacking pull requests, you may wish to do the following: 3. Merge the first PR using a merge commit otherwise your stacked PR will need a rebase. Github will automatically adjust the base branch of your other PR to be develop. [1]: https://github.com/gotwarlost/istanbul/blob/master/ignoring-code-for-coverage.md + +# Decoding Stack Traces + +Element Web has crashed and given you an obfuscated stack trace? Don't panic: +use the [Decoder Ring](https://app.element.io/decoder-ring/) (or /decoder-ring/ +on any Element Web deploy). It is somewhat of a manual process, but it should +tell you what lines the stack trace corresponds to from the source maps.