📝 Up^date doc #348
📝 Up^date doc #348
Conversation
|
|
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe recent updates encompass various aspects of the project, including configuration, documentation, and code enhancements. These changes refine setup processes, enforce schema requirements, and adjust component parameters to better align with project objectives. Collectively, they streamline development workflows, ensure data integrity, and enhance UI components, reflecting a purposeful evolution of the project. Changes
Recent Review StatusConfiguration used: CodeRabbit UI Files selected for processing (1)
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎ To accept the risk, merge this PR and you will not be notified again.
Next stepsWhat is an install script?Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts. Packages should not be running non-essential scripts during install and there are often solutions to problems people solve with install scripts that can be run at publish time instead. Take a deeper look at the dependencyTake a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev. Remove the packageIf you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency. Mark a package as acceptable riskTo ignore an alert, reply with a comment starting with
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Actionable comments outside the diff hunks (1)
packages/shared/package.json (1)
Line range hint
1-1: Verify compatibility with CommonJS module system.Removing
type: "module"switches the module system back to CommonJS. Ensure all imports/exports are compatible with CommonJS syntax.
There was a problem hiding this comment.
Actionable comments posted: 9
Actionable comments outside the diff hunks (3)
docs/open-source/contributors.mdx (3)
Line range hint
9-9: Correct the spelling of "environment" and use "set up" as a verb phrase.- ### Setup your environnement + ### Set up your environment
Line range hint
48-48: Remove unnecessary spaces before punctuation marks.- Make sure you are inside `packages/api/src` where the server lives ! + Make sure you are inside `packages/api/src` where the server lives!
Line range hint
50-50: Remove unnecessary spaces before punctuation marks.- # You want to add a new 3rd Party not yet supported ? 🧑🎤 + # You want to add a new 3rd Party not yet supported? 🧑🎤
|
|
||
| ### The source of truth | ||
|
|
||
| The `/packages/shared/src/utils.ts` file contains the most important object of the project which is `providersConfig`. |
There was a problem hiding this comment.
Consider correcting the spelling mistake in "object of the project which is providersConfig".
- The `/packages/shared/src/utils.ts` file contains the most important object of the project which is `providersConfig`.
+ The `/packages/shared/src/utils.ts` file contains the most important object of the project, which is `providersConfig`.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.
| The `/packages/shared/src/utils.ts` file contains the most important object of the project which is `providersConfig`. | |
| The `/packages/shared/src/utils.ts` file contains the most important object of the project, which is `providersConfig`. |
| .... | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Start sentences with an uppercase letter for consistency.
- where
+ WhereCommittable 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.
|
|
||
| ## IT IS VERY IMPORTANT TO MAKE SURE THE FORMAT CONVENTION IS AS FOLLOWS IN UPPERCASE: | ||
|
|
||
| `{PROVIDERNAME}_{VERTICALNAME}_{SOFTWAREMODE}_{AUTHMODE}` where |
There was a problem hiding this comment.
Start sentences with an uppercase letter for consistency.
- `{PROVIDERNAME}_{VERTICALNAME}_{SOFTWAREMODE}_{AUTHMODE}` where
+ `{PROVIDERNAME}_{VERTICALNAME}_{SOFTWAREMODE}_{AUTHMODE}` WhereCommittable 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.
| `{PROVIDERNAME}_{VERTICALNAME}_{SOFTWAREMODE}_{AUTHMODE}` where | |
| `{PROVIDERNAME}_{VERTICALNAME}_{SOFTWAREMODE}_{AUTHMODE}` Where |
| `PROVIDERNAME` is the name of the provider | ||
| `VERTICALNAME` is the vertical the provider belongs to | ||
| `SOFTWAREMODE` is the software mode the client wants to run the provider on (onpremise, cloud). By default, set it to `CLOUD`. | ||
| `AUTHMODE` is the authentication strategy of the provider (For now we have => OAUTH, API, BASIC) |
There was a problem hiding this comment.
Consider inserting an arrow for clarity in the enumeration.
- `AUTHMODE` is the authentication strategy of the provider (For now we have => OAUTH, API, BASIC)
+ `AUTHMODE` is the authentication strategy of the provider (For now we have: OAUTH, API, BASIC)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.
| `AUTHMODE` is the authentication strategy of the provider (For now we have => OAUTH, API, BASIC) | |
| `AUTHMODE` is the authentication strategy of the provider (For now we have: OAUTH, API, BASIC) |
| // i.e HUBSPOT_CRM_CLOUD_OAUTH | ||
| // i.e ZENDESK_TICKETING_CLOUD_OAUTH |
There was a problem hiding this comment.
Use periods in abbreviations consistently.
- // i.e HUBSPOT_CRM_CLOUD_OAUTH
- // i.e ZENDESK_TICKETING_CLOUD_OAUTH
+ // i.e. HUBSPOT_CRM_CLOUD_OAUTH
+ // i.e. ZENDESK_TICKETING_CLOUD_OAUTHCommittable 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.
| // i.e HUBSPOT_CRM_CLOUD_OAUTH | |
| // i.e ZENDESK_TICKETING_CLOUD_OAUTH | |
| // i.e. HUBSPOT_CRM_CLOUD_OAUTH | |
| // i.e. ZENDESK_TICKETING_CLOUD_OAUTH |
| # 2. Update the construction of the authentication url (used in the frontend) | ||
|
|
||
| Modify the `/packages/shared/src/authUrl.ts` file. | ||
|
|
There was a problem hiding this comment.
Consider adding a comma after introductory phrases for clarity.
- Right now we only coded the oAuth2 side so we'll focus on it here.
+ Right now, we only coded the oAuth2 side so we'll focus on it here.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.
docs/open-source/contributors.mdx
Outdated
| cp .env.example .env | ||
| ``` | ||
| </Step> | ||
| {" "} |
There was a problem hiding this comment.
Remove unpaired symbols that may cause formatting issues.
- {" "}
+ 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.
| {" "} |
docs/open-source/contributors.mdx
Outdated
| ./apps/frontend_snippet/node_modules ``` | ||
| </Step> | ||
|
|
||
| {" "} |
There was a problem hiding this comment.
Remove unpaired symbols that may cause formatting issues.
- {" "}
+ 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.
| {" "} |
There was a problem hiding this comment.
Actionable comments posted: 2
Actionable comments outside the diff hunks (3)
docs/open-source/contributors.mdx (3)
Line range hint
9-9: Correct the spelling of "environment" and use "set up" as two words when used as a verb.- ### Setup your environnement + ### Set up your environment
Line range hint
44-44: Remove the space before the exclamation mark.- Make sure you are inside `packages/api/src` where the server lives ! + Make sure you are inside `packages/api/src` where the server lives!
Line range hint
46-46: Remove the space before the question mark.- # You want to add a new 3rd Party not yet supported ? 🧑🎤 + # You want to add a new 3rd Party not yet supported? 🧑🎤
| }) | ||
| export class CrmConnectionModule {} | ||
| ``` | ||
| ## 2. Build your provider service | ||
|
|
||
| # You want to map a common object to your new 3rd Party ? 👩🎤 |
There was a problem hiding this comment.
Remove the space before the question mark.
- # You want to map a common object to your new 3rd Party ? 👩🎤
+ # You want to map a common object to your new 3rd Party? 👩🎤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.
| # You want to map a common object to your new 3rd Party ? 👩🎤 | |
| # You want to map a common object to your new 3rd Party? 👩🎤 |
| }) | ||
| export class ContactModule {} | ||
| ``` | ||
| The script will automatically scan the `/crm/contact/services` folder and detect any new service folder so all dependencies and imports are updated across the codebase. | ||
|
|
||
| ### Congrats Hero ! 🦸♀️ |
There was a problem hiding this comment.
Remove the space before the exclamation mark.
- ### Congrats Hero ! 🦸♀️
+ ### Congrats Hero! 🦸♀️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.
| ### Congrats Hero ! 🦸♀️ | |
| ### Congrats Hero! 🦸♀️ |
No description provided.