Skip to content

Commit bc4a9d8

Browse files
authored
docs(readme): add emojis and standardize workflows (#29)
* docs(readme): add emojis to section headers and list items * ci(workflows): standardize GitHub Actions workflows - Build: always run on push to main (remove paths filter) - Contributors: run at 1:00 AM EST, output HTML format - PR Title Lint: standardize to only lint PR titles
1 parent 241869b commit bc4a9d8

4 files changed

Lines changed: 47 additions & 27 deletions

File tree

.github/workflows/build.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ on:
1010
push:
1111
branches:
1212
- main
13-
paths:
14-
- 'src/**'
15-
- '.github/workflows/build.yml'
1613

1714
jobs:
1815
build:

.github/workflows/commit-lint.yml

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,33 @@
1-
name: Commit Lint
1+
name: Lint PR Title
22

33
on:
44
pull_request:
5-
types: [opened, edited, synchronize, reopened]
5+
types: [opened, edited, reopened, synchronize]
6+
7+
permissions:
8+
contents: read
9+
pull-requests: read
610

711
jobs:
8-
commitlint:
9-
uses: CodingWithCalvin/.github/.github/workflows/commit-lint.yml@main
12+
lint-pr-title:
13+
name: Lint PR Title
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v4
18+
19+
- name: Setup Node.js
20+
uses: actions/setup-node@v4
21+
with:
22+
node-version: '20'
23+
24+
- name: Install commitlint
25+
run: |
26+
npm install --save-dev @commitlint/cli@18.4.3 @commitlint/config-conventional@18.4.3
27+
28+
- name: Validate PR title
29+
env:
30+
PR_TITLE: ${{ github.event.pull_request.title }}
31+
run: |
32+
echo "Validating PR title: $PR_TITLE"
33+
echo "$PR_TITLE" | npx commitlint --verbose

.github/workflows/contributors.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
name: Update Contributors
22

33
on:
4-
push:
5-
branches:
6-
- main
74
schedule:
8-
- cron: '0 0 * * *'
5+
- cron: '0 6 * * *'
96
workflow_dispatch:
107

118
jobs:
129
contributors:
1310
uses: CodingWithCalvin/.github/.github/workflows/contributors.yml@main
11+
with:
12+
output-format: html
1413
secrets: inherit

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@
3434

3535
---
3636

37-
## What is this?
37+
## 🤔 What is this?
3838

3939
**VS MCP Server** exposes Visual Studio features through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), enabling AI assistants like Claude to interact with your IDE programmatically. Open files, read code, build projects, and more - all through natural conversation!
4040

41-
## Features
41+
## Features
4242

43-
### Solution Tools
43+
### 📂 Solution Tools
4444

4545
| Tool | Description |
4646
|------|-------------|
@@ -50,7 +50,7 @@
5050
| `project_list` | List all projects in the solution |
5151
| `project_info` | Get detailed project information |
5252

53-
### Document Tools
53+
### 📝 Document Tools
5454

5555
| Tool | Description |
5656
|------|-------------|
@@ -61,7 +61,7 @@
6161
| `document_read` | Read document contents |
6262
| `document_write` | Write to a document |
6363

64-
### Editor Tools
64+
### ✏️ Editor Tools
6565

6666
| Tool | Description |
6767
|------|-------------|
@@ -72,7 +72,7 @@
7272
| `editor_goto_line` | Navigate to a specific line |
7373
| `editor_find` | Search within documents |
7474

75-
### Build Tools
75+
### 🔨 Build Tools
7676

7777
| Tool | Description |
7878
|------|-------------|
@@ -82,7 +82,7 @@
8282
| `build_cancel` | Cancel a running build |
8383
| `build_status` | Get current build status |
8484

85-
## Installation
85+
## 🛠️ Installation
8686

8787
### Visual Studio Marketplace
8888

@@ -95,15 +95,15 @@
9595

9696
Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-MCPServer/releases) page and double-click to install.
9797

98-
## Usage
98+
## 🚀 Usage
9999

100-
### Starting the Server
100+
### ▶️ Starting the Server
101101

102102
1. Open Visual Studio
103103
2. Go to **Tools > MCP Server > Start Server** (or enable auto-start in settings)
104104
3. The MCP server starts on `http://localhost:5050`
105105

106-
### Configuring Claude Desktop
106+
### 🤖 Configuring Claude Desktop
107107

108108
Add this to your Claude Desktop MCP settings:
109109

@@ -117,7 +117,7 @@ Add this to your Claude Desktop MCP settings:
117117
}
118118
```
119119

120-
### Settings
120+
### ⚙️ Settings
121121

122122
Configure the extension at **Tools > Options > MCP Server**:
123123

@@ -130,7 +130,7 @@ Configure the extension at **Tools > Options > MCP Server**:
130130
| Log Level | Minimum log level for output | `Information` |
131131
| Log Retention | Days to keep log files | `7` |
132132

133-
## Architecture
133+
## 🏗️ Architecture
134134

135135
```
136136
+------------------+ +----------------------+ named pipes +------------------+
@@ -139,25 +139,25 @@ Configure the extension at **Tools > Options > MCP Server**:
139139
+------------------+ :5050 +----------------------+ +------------------+
140140
```
141141

142-
## Contributing
142+
## 🤝 Contributing
143143

144144
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better.
145145

146-
### Development Setup
146+
### 🔧 Development Setup
147147

148148
1. Clone the repository
149149
2. Open `src/CodingWithCalvin.MCPServer.slnx` in Visual Studio 2022
150150
3. Ensure you have the "Visual Studio extension development" workload installed
151151
4. Ensure you have .NET 10.0 SDK installed
152152
5. Press F5 to launch the experimental instance
153153

154-
## License
154+
## 📄 License
155155

156156
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
157157

158158
---
159159

160-
## Contributors
160+
## 👥 Contributors
161161

162162
<!-- readme: contributors -start -->
163163
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen)

0 commit comments

Comments
 (0)