Admin: Add community size of a partner organisation #1028
Conversation
…e covered by Social Income (currently 10%). Previously, we lacked a dedicated place to store this important number, which led to inconsistencies. We now request the community size from partners when establishing a partnership.
ssandino
requested review from
andrashee,
mkue and
socialincome-dev
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Warning Rate limit exceeded@ssandino has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 24 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)
📝 WalkthroughWalkthroughThe pull request introduces additional properties to the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 2
🧹 Nitpick comments (1)
admin/src/collections/PartnerOrganisations.ts (1)
22-28: Enhance contact fields configuration.Add validation and required flags:
- Mark name and number as required
- Add phone number format validation
contactName: { dataType: 'string', name: 'Contact Person', + required: true, }, contactNumber: { dataType: 'string', name: 'Contact Number', + required: true, + validation: { + format: 'tel', + }, + description: 'Include country code (e.g., +41 123 456 789)', },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
admin/src/collections/PartnerOrganisations.ts(1 hunks)shared/src/types/partner-organisation.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: Test functions
- GitHub Check: Test admin
- GitHub Check: Test website
- GitHub Check: Test shared code
- GitHub Check: Prettify
- GitHub Check: Security checks (typescript)
| @@ -4,4 +4,5 @@ export type PartnerOrganisation = { | |||
| name: string; | |||
| contactName: string; | |||
| contactNumber: string; | |||
| communitySize: number; | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add validation constraints for communitySize.
Since this represents the number of people in a community:
- Negative values should be prevented
- Consider adding a minimum value check (e.g., > 0)
- communitySize: number;
+ communitySize: {
+ type: number;
+ minimum: 1;
+ };Committable suggestion skipped: line range outside the PR's diff.
| communitySize: { | ||
| dataType: 'number', | ||
| name: 'Community Size', | ||
| }, |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance communitySize field configuration.
Add validation and helpful context:
- Mark as required field
- Add validation rules
- Add description explaining the 10% recipient calculation
communitySize: {
dataType: 'number',
name: 'Community Size',
+ validation: {
+ min: 1,
+ },
+ required: true,
+ description: 'Total number of people in the community. Social Income will cover 10% of this number as recipients.',
},📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| communitySize: { | |
| dataType: 'number', | |
| name: 'Community Size', | |
| }, | |
| communitySize: { | |
| dataType: 'number', | |
| name: 'Community Size', | |
| validation: { | |
| min: 1, | |
| }, | |
| required: true, | |
| description: 'Total number of people in the community. Social Income will cover 10% of this number as recipients.', | |
| }, |
|
Visit the preview URL for this PR (updated for commit 6fe2e1a): https://si-admin-staging--pr1028-sandino-add-communit-j4jqpuby.web.app (expires Sat, 01 Feb 2025 13:57:13 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: b7b0969384059dce6ea8fad1ee1d1737e54e6676 |
The community size number is used to calculate how many recipients are covered by Social Income (currently 10%). Previously, we lacked a dedicated place to store this important number, which led to inconsistencies. We now request the community size from partners when establishing a partnership.
Summary by CodeRabbit
New Features
Improvements