Adopting Berlin Code of Conduct for Express Zod API #2845
Conversation
RobinTail
added
documentation
|
Warning Rate limit exceeded@RobinTail has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 4 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThe existing Contributor Covenant Code of Conduct was replaced with a new, customized Code of Conduct adapted from the Berlin Code of Conduct. The revised document outlines expectations, unacceptable behaviors, consequences, and reporting procedures specific to the Express Zod API community. No changes were made to code or exported entities. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
CODE_OF_CONDUCT.md (2)
14-15: Use consistent heading levels to satisfy markdown-lint MD001The document jumps from an H1 (
#) to multiple H3 (###) headings, violating the “increment by one level” rule and harming accessibility tooling that relies on a proper outline.-### Key Expectations for Participants -### Unacceptable Behaviors -### Consequences of Unacceptable Behavior -### Reporting Guidelines -### Scope and Applicability +## Key Expectations for Participants +## Unacceptable Behaviors +## Consequences of Unacceptable Behavior +## Reporting Guidelines +## Scope and ApplicabilityAlso applies to: 30-31, 49-50, 59-60, 77-78
66-69: Replace fragile GitHub line-link with a stable contact methodLinking to
package.json#L14will break whenever that file is reformatted.
Either embed amailto:link or reference a dedicatedMAINTAINERS.md.- [email](https://github.com/RobinTail/express-zod-api/blob/master/express-zod-api/package.json#L14). + [email the maintainers](mailto:[email protected]).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CODE_OF_CONDUCT.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: RobinTail
PR: RobinTail/express-zod-api#2697
File: CHANGELOG.md:5-5
Timestamp: 2025-06-02T21:11:20.768Z
Learning: In the express-zod-api repository, RobinTail follows a release workflow where package.json version is only updated on the master branch after merging all planned release changes. Changelog entries may show future version numbers while package.json remains at the previous version during feature development, and this is intentional workflow, not a version inconsistency that needs to be flagged.
Learnt from: RobinTail
PR: RobinTail/express-zod-api#2546
File: example/factories.ts:35-42
Timestamp: 2025-05-27T20:03:34.213Z
Learning: The `./example` directory in the express-zod-api repository contains demonstration code for educational purposes only, not intended for production use. Example code can make simplified assumptions for brevity and clarity, and should not be flagged for missing production-level error handling, security measures, or edge case handling.
CODE_OF_CONDUCT.md (6)
Learnt from: RobinTail
PR: #2546
File: example/factories.ts:35-42
Timestamp: 2025-05-27T20:03:34.213Z
Learning: The ./example directory in the express-zod-api repository contains demonstration code for educational purposes only, not intended for production use. Example code can make simplified assumptions for brevity and clarity, and should not be flagged for missing production-level error handling, security measures, or edge case handling.
Learnt from: RobinTail
PR: #2736
File: express-zod-api/tsup.config.ts:12-26
Timestamp: 2025-06-14T16:42:52.972Z
Learning: In express-zod-api tsup configurations, the direct mutation of options.supported in the esbuildOptions callback is intentional behavior and should not be flagged as a side effect issue.
Learnt from: RobinTail
PR: #2697
File: CHANGELOG.md:5-5
Timestamp: 2025-06-02T21:08:56.475Z
Learning: The cjs-test directory in the express-zod-api repository is a test workspace and should be excluded when checking for main project version consistency with changelog entries.
Learnt from: RobinTail
PR: #2546
File: express-zod-api/tests/buffer-schema.spec.ts:32-37
Timestamp: 2025-05-27T19:35:57.357Z
Learning: In the express-zod-api project, tests are run from the express-zod-api workspace directory, and the project uses an ESM-first environment without __dirname. Relative paths like ../logo.svg in test files correctly resolve to the repository root due to this test execution context.
Learnt from: RobinTail
PR: #2546
File: express-zod-api/src/documentation-helpers.ts:508-512
Timestamp: 2025-05-28T07:58:09.853Z
Learning: In express-zod-api, when working with Zod's JSON schema override callbacks, using delete to mutate ctx.jsonSchema is the recommended approach per Zod's official documentation, even if it triggers performance linting warnings. This is preferable to creating copies with undefined values, especially for snapshot testing.
Learnt from: RobinTail
PR: #2697
File: CHANGELOG.md:5-5
Timestamp: 2025-06-02T21:11:20.768Z
Learning: In the express-zod-api repository, RobinTail follows a release workflow where package.json version is only updated on the master branch after merging all planned release changes. Changelog entries may show future version numbers while package.json remains at the previous version during feature development, and this is intentional workflow, not a version inconsistency that needs to be flagged.
🪛 LanguageTool
CODE_OF_CONDUCT.md
[style] ~27-~27: ‘in distress’ might be wordy. Consider a shorter alternative.
Context: ...notice a dangerous situation, someone in distress, or violations of this Code of Conduct,...
(EN_WORDINESS_PREMIUM_IN_DISTRESS)
[style] ~56-~56: ‘without warning’ might be wordy. Consider a shorter alternative.
Context: ... editing/deletion of offending content, without warning or refund (if applicable to any paid ...
(EN_WORDINESS_PREMIUM_WITHOUT_WARNING)
🪛 markdownlint-cli2 (0.17.2)
CODE_OF_CONDUCT.md
14-14: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
CODE_OF_CONDUCT.md (1)
92-97: Add explicit CC BY-SA 4.0 attribution linePrevious review already requested a succinct attribution/notice to satisfy CC BY-SA §3(a).
Please append the copyright + license statement after line 96.distribute your contributions under the same license as the original. + +© 2025 Express Zod API contributors — Licensed under CC BY-SA 4.0
🧹 Nitpick comments (1)
CODE_OF_CONDUCT.md (1)
14-90: Align heading levels with Markdown lint rule MD001All section headings after the document title jump from
#straight to###, violating “heading levels should only increment by one level at a time”.
Convert them to##to silence CI markdown-lint and keep the structure clean.-### Key Expectations for Participants +## Key Expectations for Participants … -### Unacceptable Behaviors +## Unacceptable Behaviors … -### Consequences of Unacceptable Behavior +## Consequences of Unacceptable Behavior … -### Reporting Guidelines +## Reporting Guidelines … -### Scope and Applicability +## Scope and Applicability … -### License +## License
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CODE_OF_CONDUCT.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: RobinTail
PR: RobinTail/express-zod-api#2697
File: CHANGELOG.md:5-5
Timestamp: 2025-06-02T21:11:20.768Z
Learning: In the express-zod-api repository, RobinTail follows a release workflow where package.json version is only updated on the master branch after merging all planned release changes. Changelog entries may show future version numbers while package.json remains at the previous version during feature development, and this is intentional workflow, not a version inconsistency that needs to be flagged.
Learnt from: RobinTail
PR: RobinTail/express-zod-api#2546
File: example/factories.ts:35-42
Timestamp: 2025-05-27T20:03:34.213Z
Learning: The `./example` directory in the express-zod-api repository contains demonstration code for educational purposes only, not intended for production use. Example code can make simplified assumptions for brevity and clarity, and should not be flagged for missing production-level error handling, security measures, or edge case handling.
CODE_OF_CONDUCT.md (6)
Learnt from: RobinTail
PR: #2546
File: example/factories.ts:35-42
Timestamp: 2025-05-27T20:03:34.213Z
Learning: The ./example directory in the express-zod-api repository contains demonstration code for educational purposes only, not intended for production use. Example code can make simplified assumptions for brevity and clarity, and should not be flagged for missing production-level error handling, security measures, or edge case handling.
Learnt from: RobinTail
PR: #2736
File: express-zod-api/tsup.config.ts:12-26
Timestamp: 2025-06-14T16:42:52.972Z
Learning: In express-zod-api tsup configurations, the direct mutation of options.supported in the esbuildOptions callback is intentional behavior and should not be flagged as a side effect issue.
Learnt from: RobinTail
PR: #2697
File: CHANGELOG.md:5-5
Timestamp: 2025-06-02T21:08:56.475Z
Learning: The cjs-test directory in the express-zod-api repository is a test workspace and should be excluded when checking for main project version consistency with changelog entries.
Learnt from: RobinTail
PR: #2546
File: express-zod-api/tests/buffer-schema.spec.ts:32-37
Timestamp: 2025-05-27T19:35:57.357Z
Learning: In the express-zod-api project, tests are run from the express-zod-api workspace directory, and the project uses an ESM-first environment without __dirname. Relative paths like ../logo.svg in test files correctly resolve to the repository root due to this test execution context.
Learnt from: RobinTail
PR: #2546
File: express-zod-api/src/documentation-helpers.ts:508-512
Timestamp: 2025-05-28T07:58:09.853Z
Learning: In express-zod-api, when working with Zod's JSON schema override callbacks, using delete to mutate ctx.jsonSchema is the recommended approach per Zod's official documentation, even if it triggers performance linting warnings. This is preferable to creating copies with undefined values, especially for snapshot testing.
Learnt from: RobinTail
PR: #2697
File: CHANGELOG.md:5-5
Timestamp: 2025-06-02T21:11:20.768Z
Learning: In the express-zod-api repository, RobinTail follows a release workflow where package.json version is only updated on the master branch after merging all planned release changes. Changelog entries may show future version numbers while package.json remains at the previous version during feature development, and this is intentional workflow, not a version inconsistency that needs to be flagged.
🪛 LanguageTool
CODE_OF_CONDUCT.md
[style] ~27-~27: ‘in distress’ might be wordy. Consider a shorter alternative.
Context: ...notice a dangerous situation, someone in distress, or violations of this Code of Conduct,...
(EN_WORDINESS_PREMIUM_IN_DISTRESS)
[style] ~56-~56: ‘without warning’ might be wordy. Consider a shorter alternative.
Context: ... editing/deletion of offending content, without warning or refund (if applicable to any paid ...
(EN_WORDINESS_PREMIUM_WITHOUT_WARNING)
🪛 markdownlint-cli2 (0.17.2)
CODE_OF_CONDUCT.md
14-14: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: report
Summary by CodeRabbit