From 566f6251942b33212c068cf12d3fd216f21300fd Mon Sep 17 00:00:00 2001 From: Damodar Lohani Date: Tue, 4 Jan 2022 20:27:31 +0545 Subject: [PATCH] sdk generating check list --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a453a3b5..341ffcd0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -295,6 +295,16 @@ For generating a new console SDK follow the next steps: 5. Copy `iife/sdk.js` to `appwrite.js` 6. Go back to the root of the project `run npm run build` +## Checklist for Releasing SDKs + +Things to remember when releasing SDKs + +* Update the Changelogs in **docs/sdks** (right now only Dart and Flutter are using these) +* Update **GETTING_STARTED.md** in **docs/sdks** for each SDKs if any changes in the related APIs in there +* Update SDK versions as required on **app/config/platforms.php** +* Generate SDKs using the command `php app/cli.php sdks` and follow the instructions +* Release new tags on GitHub repository for each SDKs + ## Debug Appwrite uses [yasd](https://github.com/swoole/yasd) debugger, which can be made available during build of Appwrite. You can connect to the debugger using VS Code [PHP Debug](https://marketplace.visualstudio.com/items?itemName=felixfbecker.php-debug) extension or if you are in PHP Storm you don't need any plugin. Below are the settings required for remote debugger connection.