docs(ses): Provide guidance/coordination for SES incompatibility tracking #1612
Conversation
| }); | ||
| ``` | ||
|
|
||
| Upon encountering an incompatibility, we recommend that you add a comment to |
packages/ses/README.md
Outdated
| ``` | ||
|
|
||
| Upon encountering an incompatibility, we recommend that you add a comment to | ||
| [issue #576][incompatibility tracking] and file an issue with the external project referencing this section. |
There was a problem hiding this comment.
we could reduce the load for filing the issue by providing a template. e.g.
Some applications defend themselves by freezing their intrinsics. This project has some assignments or mutations that break in such an environment.
Specifically,
[link to source in the project]Please consider making the project compatible with these environments by avoiding mutations to intrinsics.
If you don't have the capacity but would accept a PR, please comment to that effect so that a volunteer knows their efforts would be welcomed.
There was a problem hiding this comment.
Good idea, and thank you for the starting point. PTAL.
There was a problem hiding this comment.
I think we can narrow this from "assignment or mutation" to just "assignment".
by avoiding mutations to intrinsics
Is sometimes the issue and should be mentioned when relevant. But by far the most common case is using assignment to override a property inherited from a frozen intrinsic, i.e., the override mistake. We should always lead with the override mistake.
There was a problem hiding this comment.
And for the override mistake, always first suggest doing the override by defineProperty rather than assignment, because that is much more likely to be correctness preserving and least effort.
There was a problem hiding this comment.
Or rather defineProperties since that's what is already shown in this PR's example code.
gibson042
force-pushed
the
gibson-1611-ses-incompatibilities
branch
from
5c8b136
to
f9c4283
Compare
gibson042
force-pushed
the
gibson-1611-ses-incompatibilities
branch
from
f9c4283
to
9217767
Compare
Fixes #1611