Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 07:15 UTC
| 1 | Check the changes between the current branch and next branch, and create a changelog file inside `/docs/content/changelog` in the file format of `MM-DD-YY-<title>.mdx`. |
| 2 | |
| 3 | ## File Naming |
| 4 | |
| 5 | ``` |
| 6 | MM-DD-YY.mdx # e.g., 12-29-25.mdx |
| 7 | MM-DD-YY-suffix.mdx # Multiple same day: 12-10-25-masking.mdx |
| 8 | ``` |
| 9 | |
| 10 | ## Template |
| 11 | |
| 12 | ```mdx |
| 13 | --- |
| 14 | title: "Your Title Here" |
| 15 | description: "Brief description of the change" |
| 16 | date: "YYYY-MM-DD" |
| 17 | --- |
| 18 | |
| 19 | Brief intro paragraph explaining what changed. |
| 20 | |
| 21 | ### SDK Versions |
| 22 | |
| 23 | | SDK | Version | |
| 24 | |-----|---------| |
| 25 | | Python | vX.Y.Z+ | |
| 26 | | TypeScript | vX.Y.Z+ | |
| 27 | |
| 28 | ### What Changed (if applicable) |
| 29 | |
| 30 | **Before:** |
| 31 | ```python |
| 32 | old_code() |
| 33 | ``` |
| 34 | |
| 35 | **After:** |
| 36 | ```python |
| 37 | new_code() |
| 38 | ``` |
| 39 | |
| 40 | ### Breaking Changes (if applicable) |
| 41 | |
| 42 | <Callout type="warn"> |
| 43 | **Breaking Change** |
| 44 | |
| 45 | What breaks and why. |
| 46 | </Callout> |
| 47 | |
| 48 | ### What's New / Improvements / Bug Fixes |
| 49 | |
| 50 | - Change 1 |
| 51 | - Change 2 |
| 52 | |
| 53 | ### Backward Compatibility |
| 54 | |
| 55 | Notes about backward compatibility. |
| 56 | ``` |
| 57 | |
| 58 | ## Rules |
| 59 | |
| 60 | 1. **Frontmatter required** - `title`, `description`, and `date` (YYYY-MM-DD format) |
| 61 | 2. **No `#` heading** - Title renders automatically from frontmatter |
| 62 | 3. **Use `###` for sections** - Content headings start at h3 |
| 63 | 4. **No emojis** - No checkmarks, warning symbols, etc. in prose (okay in code comments) |
| 64 | 5. **TypeScript code blocks** - Add `// @noErrors` on first line to skip type checking |
| 65 | |
| 66 | ## Change Types |
| 67 | |
| 68 | | Type | How to Format | |
| 69 | |------|---------------| |
| 70 | | Breaking Change | `<Callout type="warn">` + before/after code + migration guide | |
| 71 | | New Feature | `### What's New` | |
| 72 | | Improvement | `### Improvements` | |
| 73 | | Bug Fix | `### Bug Fixes` or inline description | |
| 74 | | Deprecation | `<Callout>` with timeline | |
| 75 | |
| 76 | ## Code Examples |
| 77 | |
| 78 | For TypeScript code that shouldn't be type-checked: |
| 79 | |
| 80 | ```typescript |
| 81 | // @noErrors |
| 82 | const result = await composio.tools.get(userId); |
| 83 | ``` |
| 84 | |
| 85 | For before/after comparisons, use labeled sections: |
| 86 | |
| 87 | **Before:** |
| 88 | ```python |
| 89 | old_code() |
| 90 | ``` |
| 91 | |
| 92 | **After:** |
| 93 | ```python |
| 94 | new_code() |
| 95 | ``` |
| 96 | |
| 97 | ## Examples |
| 98 | |
| 99 | Reference these existing changelogs for style: |
| 100 | - Bug fix: `01-21-26-initiate-active-status-filter.mdx` |
| 101 | - Breaking change: `01-14-26-auth-config-patch-semantics.mdx` |
| 102 | - New feature: `01-12-26-tool-router-improvements.mdx` |
| 103 | - Simple change: `01-30-26-simplified-optional-schemas.mdx` |