docs: update the directory structure in CONTRIBUTING.md#10342
Conversation
📝 WalkthroughWalkthroughThe changes reorganize the repository structure. New app/assets (dbip, fonts, security) and app/config (avatars, collections, locale, specs, storage, templates) directories were added. Top-level items like db, sdks, tasks, views, workers were removed or moved; database init now under init/database, and views under app/views/{general,install}. Docker references were replaced with dev. Docs gained lists, references, sdks, services, specs, tutorials. Public folder dropped dist and removed scripts/styles, retaining fonts/images. Src was restructured with sdk-console, sdk-project, sdk-web and expanded Appwrite modules plus Executor. Tests now include benchmarks and extensions. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Rationale: Broad but mostly structural and organizational changes with consistent patterns across folders; minimal logic exposure and no public API declaration changes. Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
Security Scan Results for PRDocker Image Scan Results
Source Code Scan Results🎉 No vulnerabilities found! |
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
540-559: Update SDK generation docs to match the new directory structureThe SDK-generation instructions in CONTRIBUTING.md (lines 540–559) still point at the old
app/config/specsandapp/sdksfolders, which no longer exist. Please align them with the current layout:• In CONTRIBUTING.md:
– Replaceapp/config/specs/swagger2-<version-number>.console.jsonwithdocs/specs/swagger2-<version-number>.console.json.
– Change “cd app/sdks/console-web” to “cd public/sdk-console” (or the appropriatepublic/sdk-<name>folder).
– Update the build/copy steps to pull the generatediife/sdk.jsfrompublic/sdk-consoleand copy it toappwrite.js.• Verify that the CLI commands still emit specs to
docs/specs(php app/cli.php specs …) and SDK bundles topublic/sdk-console(php app/cli.php sdks).• In app/config/platforms.php (around line 211), update the
realpath(__DIR__ . '/../sdks/console-web')reference to point at the newpublic/sdk-consolepath.• Remove or update the outdated
"./app/sdks"entry in pint.json’sexcludelist, since that directory has been removed.These changes are required to keep the CONTRIBUTING guide accurate and prevent broken paths.
🧹 Nitpick comments (2)
CONTRIBUTING.md (2)
262-262: Close the dangling parenthetical in the src lineMinor polish: the comment starts a parenthesis but never closes it. Suggest completing the sentence.
-├── src # Supporting libraries (each lib has one role, common libs are released as +├── src # Supporting libraries (each lib has one role; common libs are released as Composer packages)
258-261: Clarify public SDK artifacts in CONTRIBUTING.mdWe’ve confirmed that
public/sdk-console,public/sdk-project, andpublic/sdk-webare indeed committed as built SDK artifacts in this repo. To avoid confusion with the separate Console UI repo, please annotate the directory tree inCONTRIBUTING.mdto indicate these folders are generated artifacts (and link back to their source repositories).• File: CONTRIBUTING.md (around lines 258–261)
• Update thepublic/section to something like:- public/ - │ ├── sdk-console - │ ├── sdk-project - │ └── sdk-web + public/ # Prebuilt SDK artifacts (committed; generated via build scripts) + │ ├── sdk-console # SDK for the Console UI (source: github.com/your-org/console) + │ ├── sdk-project # SDK for Project core library + │ └── sdk-web # SDK for web applications
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🔇 Additional comments (4)
CONTRIBUTING.md (4)
262-287: All Appwrite submodules confirmedAll entries in the CONTRIBUTING.md tree (including Vcs, Promises, Functions/Validator, Task/Validator, SDK) have been verified against the repo and their directory names and casing match exactly. No updates to the list are needed.
246-246: DEV directory rename validated – no local “docker/” references foundI searched the repo for any references to a top-level docker/ path and found only:
- Workflow action names (e.g. uses: docker/setup-buildx-action@…)
- External mentions of Docker in README-CN.md
There are no lingering links or code comments pointing to a local docker/ directory. The dev/ folder and dev/xdebug.ini are present as expected.
241-245: App directory structure verifiedAll of the moved paths exist and align with the names used in CONTRIBUTING.md:
- app/init/database
- app/views
- app/views/general
- app/views/install
No further changes needed.
289-294: Tests directory structure is valid and commands are up to dateAll listed test directories are present under
tests/:
- benchmarks
- e2e (including
Services)- extensions
- resources
- unit
The
docker compose exec appwrite test …commands in CONTRIBUTING.md (lines 612, 618, 624) correctly reference:
/usr/src/code/tests/unit/usr/src/code/tests/e2e/usr/src/code/tests/e2e/Services/[ServiceName]No stale or broken paths detected.
What does this PR do?
Updates the directory structure in
CONTRIBUTING.mdto match the current structure.Related PRs and Issues
Checklist