Stale JSDoc: `CordieriteConnectOptions.linkPin` still says link trust is debug-build-only
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 94/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- documentation
Research direction
Read docs/SECURITY.md, especially the “Trust modes” section, and compare it with the JSDoc in packages/react-native/src/Cordierite.types.ts:57-63. Update the linkPin comment so it describes link trust as the default when cliPins is empty in every build type, while noting that embedded pins take precedence. No behavior change is expected.
Written by the indexing model from the issue text.
Description
Found while reviewing #33.
packages/react-native/src/Cordierite.types.ts:57-63 documents linkPin as trusted only "when built in debug mode with no build-time cliPins configured" and says "release builds without pins keep the existing hard error". That predates the explicit trust mode: resolveTrustedPins on both platforms consults no build-type signal, and docs/SECURITY.md "Trust modes" describes link trust as available in any build type when no cliPins are configured.
Fix: reword the comment to match docs/SECURITY.md (trust mode "link" is the default whenever cliPins is empty, in every build type; embedded pins always win). No behaviour change.
- Dominant language
- TypeScript
- Stars
- 17
- Forks
- 0
- Avg merge
- 19h 18m
- Merged PRs (30d)
- 27
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from callstackincubator/appduct
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 68/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
All issues in callstackincubator/appduct
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100