PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Document the decoder ring (#24317)

Browse source 
* Document the decoder ring

Also a few little tidy-ups.

* Prettier
This commit is contained in:
David Baker 2023-01-26 15:43:02 +00:00 committed by GitHub
parent bd26775dcb
commit 1bb354e96d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
CONTRIBUTING.md
View file

@ -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: 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) - 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 - 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 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 - 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. 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 ### Changelogs
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 There's no need to manually add Changelog entries: we use information in the
the `Notes:` annotation in the description. By default, the PR title will be pull request to populate the information that goes into the changelogs our
used for the changelog entry, but you can specify more options, as follows. 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: 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. 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 [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.