Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 152 additions & 0 deletions .github/skills/writing-release-notes/CHANGELOG-FORMAT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# Changelog Format Reference

This document defines the format and style for `CHANGELOG.md` entries.

## File Location

`/CHANGELOG.md` (repository root)

## Structure

```markdown
# Change Log

## X.Y.Z

### Category

- **Feature Name**: Brief description. [#issue](link), [#pr](link)

## X.Y.Z-1

### Category

...
```

## Categories

Use these categories in order of priority:

1. `### New Features` - Major new functionality
2. `### New Features & Improvements` - Combined features and improvements
3. `### Improvements` - Enhancements to existing features
4. `### Fixes` - Bug fixes
5. `### Security` - Security-related updates

## Entry Format

```markdown
- **Short Title**: One to two sentence description of the change. [#123](https://github.com/microsoft/vscode-documentdb/issues/123), [#456](https://github.com/microsoft/vscode-documentdb/pull/456)
```

### Rules

1. **Bold title** summarizing the change (2-5 words)
2. **Description** in 1-2 sentences, factual and technical
3. **Links** to issues and PRs at the end
4. Use present tense ("Adds", "Fixes", "Updates")
5. No trailing period after links

## Examples

### Feature Entry

```markdown
- **Query Insights**: The Query Insights feature has been updated to use the available `executionStats` instead of running the analysis in the AI context, improving performance and reliability. [#404](https://github.com/microsoft/vscode-documentdb/issues/404), [#423](https://github.com/microsoft/vscode-documentdb/pull/423)
```

### Fix Entry

```markdown
- **Azure Tenant Filtering in Service Discovery**: Resolved an issue where users could not deselect tenants when filtering from a large number of available tenants. [#391](https://github.com/microsoft/vscode-documentdb/issues/391), [#415](https://github.com/microsoft/vscode-documentdb/pull/415)
```

### Improvement Entry

```markdown
- **Dependency Upgrades**: Upgraded to React 19 and SlickGrid 9, enhancing UI performance and modernizing the webview components. [#406](https://github.com/microsoft/vscode-documentdb/issues/406), [#407](https://github.com/microsoft/vscode-documentdb/pull/407)
```

### Security Entry

```markdown
- **Dependency Security Update**: Updated `tRPC` dependencies to address a security vulnerability. [#430](https://github.com/microsoft/vscode-documentdb/issues/430), [#431](https://github.com/microsoft/vscode-documentdb/pull/431)
```

## Version Section Template

### For Major/Minor Release (X.Y.0)

```markdown
## X.Y.0

### New Features & Improvements

- **Feature One**: Description of the feature and its benefits. [#issue](link), [#pr](link)
- **Feature Two**: Description of another feature. [#issue](link)

### Fixes

- **Bug Title**: Description of what was fixed. [#issue](link), [#pr](link)
```

### For Patch Release (X.Y.Z)

```markdown
## X.Y.Z

### Improvements

- **Improvement Title**: Brief description. [#issue](link), [#pr](link)

### Fixes

- **Fix Title**: Brief description. [#issue](link), [#pr](link)
```

## Anti-Patterns to Avoid

❌ **Too verbose**

```markdown
- **Feature**: This is a very long description that goes into extreme detail about every aspect of the feature and how it works internally and why we made certain decisions...
```

✅ **Concise**

```markdown
- **Feature**: Adds support for X, improving Y workflow. [#123](link)
```

---

❌ **Missing links**

```markdown
- **Feature**: Added new capability.
```

✅ **With links**

```markdown
- **Feature**: Added new capability. [#123](link), [#124](link)
```

---

❌ **Inconsistent formatting**

```markdown
- Feature: description
- **Another Feature** - description
- **Third Feature**: Description.
```

✅ **Consistent formatting**

```markdown
- **Feature One**: Description. [#1](link)
- **Feature Two**: Description. [#2](link)
- **Feature Three**: Description. [#3](link)
```
115 changes: 115 additions & 0 deletions .github/skills/writing-release-notes/EXAMPLES-MAJOR-RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# Major Release Example Template

This is a complete example of a major/minor release notes file (X.Y.0).

---

## Template

```markdown
> **Release Notes** — [Back to Release Notes](../index.md#release-notes)

---

# DocumentDB for VS Code Extension vX.Y

We are excited to announce the release of **DocumentDB for VS Code Extension vX.Y**. This is a landmark update for our DocumentDB and MongoDB GUI, focused on [primary theme]. It introduces [headline feature], enhances [secondary improvement], and improves [third improvement] for developers working with DocumentDB and MongoDB API databases.

## What's New in vX.Y

### ⭐ Headline Feature Name

We are introducing a major new feature: **Feature Name**. This powerful tool helps you [primary benefit] directly within VS Code. When you [trigger action], a new **"UI Element"** appears, providing [what it provides].

<p align="center"><img src="./images/X.Y.0_feature_screenshot.png" alt="Feature Description" width="800" style="max-width:100%;height:auto;"></p>

- **Capability 1: Name**
Description of the first capability and its benefits.

- **Capability 2: Name**
Description of the second capability.

- **Capability 3: Name**
Description of the third capability.

The **"Feature Name"** feature helps [solve problem] and educates users on [topic] for DocumentDB and MongoDB API databases.

### ⭐ Second Major Feature

We've enhanced [area] to support [new capability]. Previously, [limitation]. Now, you have [new capability], enabling [benefit] without leaving VS Code.

<p align="center"><img src="./images/X.Y.0_second_feature.png" alt="Feature Description" width="800" style="max-width:100%;height:auto;"></p>

### ⭐ Third Feature

Description of the third feature. Simply [action] to [result]. This direct workflow helps you [benefit] right from the explorer.

<p align="center"><img src="./images/X.Y.0_third_feature.png" alt="Feature Description" width="360" style="max-width:100%;height:auto;"></p>

## Key Fixes and Improvements

- **Improvement Category**
- Fixed an issue where [component] could [problem].
- Corrected a problem where [another component] was [problem].

## Changelog

See the full changelog entry for this release:
➡️ [CHANGELOG.md#XYZ](https://github.com/microsoft/vscode-documentdb/blob/main/CHANGELOG.md#XYZ)
```

---

## Real Example (v0.6.0)

```markdown
> **Release Notes** — [Back to Release Notes](../index.md#release-notes)

---

# DocumentDB for VS Code Extension v0.6

We are excited to announce the release of **DocumentDB for VS Code Extension v0.6**. This is a landmark update for our DocumentDB and MongoDB GUI, focused on query optimization and developer productivity. It introduces a powerful new **Query Insights with Performance Advisor**, enhances query authoring capabilities, and improves index management for developers working with DocumentDB and MongoDB API databases.

## What's New in v0.6

### ⭐ Query Insights with Performance Advisor

We are introducing a major new feature: **Query Insights with Performance Advisor**. This powerful tool helps you understand and optimize your queries directly within VS Code. When you run a `find` query against your DocumentDB or MongoDB API database, a new **"Query Insights"** tab appears, providing a three-stage analysis of your query's performance.

<p align="center"><img src="./images/0.6.0_query_insights.png" alt="Query Insights Panel" width="800" style="max-width:100%;height:auto;"></p>

- **Stage 1: Initial Performance View**
The first stage provides an immediate, low-cost static analysis of your query. It visualizes the query plan, showing how the database intends to execute your query.

- **Stage 2: Detailed Execution Analysis**
For a deeper dive, the second stage runs a detailed execution analysis using `executionStats` to gather authoritative metrics.

- **Stage 3: AI-Powered Recommendations with GitHub Copilot**
The final stage brings the power of AI to your query optimization workflow.

The **"Query Insights"** feature helps solve performance issues and educates users on query best practices for DocumentDB and MongoDB API databases.

### ⭐ Improved Query Specification

We've enhanced the query authoring experience to support more sophisticated queries. Previously, you could only specify the `filter` for a `find` query. Now, you have full control to include `projection`, `sort`, `skip`, and `limit` parameters directly in the query editor.

<p align="center"><img src="./images/0.6.0_project_sort_skip_limit.png" alt="Query Parameters" width="800" style="max-width:100%;height:auto;"></p>

### ⭐ Index Management from the Tree View

Managing your indexes is now easier and more intuitive than ever. You can now `drop`, `hide`, and `unhide` indexes directly from the Connections View.

<p align="center"><img src="./images/0.6.0_index_management.png" alt="Index Management" width="360" style="max-width:100%;height:auto;"></p>

## Key Fixes and Improvements

- **Improved UI element visibility**
- Fixed an issue where the autocomplete list in the query area could be hidden behind other UI elements.
- Corrected a problem where tooltips in the table and tree views were sometimes displayed underneath the selection indicator.

## Changelog

See the full changelog entry for this release:
➡️ [CHANGELOG.md#060](https://github.com/microsoft/vscode-documentdb/blob/main/CHANGELOG.md#060)
```
Loading