Skip to content

Commit 958b777

Browse files
authored
docs(readme): add emojis and standardize workflows (#17)
* 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 - Preview Changelog: add missing workflow
1 parent a6d04e7 commit 958b777

5 files changed

Lines changed: 57 additions & 45 deletions

File tree

.github/workflows/build.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ on:
1111
push:
1212
branches:
1313
- main
14-
paths:
15-
- 'src/**'
16-
- '*.slnx'
17-
- '.github/workflows/build.yml'
1814

1915
jobs:
2016
build:

.github/workflows/commit-lint.yml

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
1-
name: Commit Lint
1+
name: Lint PR Title
22

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

711
jobs:
8-
commitlint:
12+
lint-pr-title:
13+
name: Lint PR Title
914
runs-on: ubuntu-latest
1015
steps:
11-
- name: Checkout
16+
- name: Checkout code
1217
uses: actions/checkout@v4
13-
with:
14-
fetch-depth: 0
1518

1619
- name: Setup Node.js
1720
uses: actions/setup-node@v4
1821
with:
19-
node-version: 20
22+
node-version: '20'
2023

2124
- name: Install commitlint
2225
run: |
23-
npm install --save-dev @commitlint/cli @commitlint/config-conventional
26+
npm install --save-dev @commitlint/cli@18.4.3 @commitlint/config-conventional@18.4.3
2427
25-
- name: Lint PR title
28+
- name: Validate PR title
2629
env:
2730
PR_TITLE: ${{ github.event.pull_request.title }}
28-
run: echo "$PR_TITLE" | npx commitlint
29-
30-
- name: Lint commits
31-
run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose
31+
run: |
32+
echo "Validating PR title: $PR_TITLE"
33+
echo "$PR_TITLE" | npx commitlint --verbose

.github/workflows/contributors.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@ name: Update Contributors
22

33
on:
44
schedule:
5-
- cron: '0 0 * * *'
5+
- cron: '0 6 * * *'
66
workflow_dispatch:
77

88
jobs:
99
contributors:
1010
uses: CodingWithCalvin/.github/.github/workflows/contributors.yml@main
11+
with:
12+
output-format: html
1113
secrets: inherit
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Preview Changelog
2+
3+
run-name: Preview release notes for next release
4+
5+
on:
6+
workflow_dispatch:
7+
8+
jobs:
9+
preview:
10+
name: Preview
11+
uses: CodingWithCalvin/.github/.github/workflows/generate-changelog.yml@main
12+
secrets: inherit

README.md

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

3535
---
3636

37-
## Updated Interface
37+
## 🖼️ Updated Interface
3838

3939
<p align="center">
4040
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-Debugalizers/main/resources/updated-interface.png" alt="Updated Debugalizers Interface" width="700">
@@ -44,7 +44,7 @@
4444

4545
> **Note:** The screenshots below were captured before the UI overhaul. The updated interface shown above features a modernized design with improved theming, rounded corners, and a cleaner layout. All functionality remains the same.
4646
47-
## Screenshots
47+
## 📸 Screenshots
4848

4949
<p align="center">
5050
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-Debugalizers/main/resources/debugalizers-list.png" alt="Debugalizers List" width="400">
@@ -115,18 +115,18 @@
115115
</tr>
116116
</table>
117117

118-
## Features
118+
## Features
119119

120-
- **30+ Visualizers** - JSON, XML, JWT, Base64, images, and many more
121-
- **Multiple Views** - Raw, Formatted, Tree, Table, Hex, Rendered, and Image
122-
- **Syntax Highlighting** - Beautiful code highlighting via AvalonEdit
123-
- **Search** - Find text within large content (Ctrl+F)
124-
- **Copy & Export** - Copy raw/formatted content or export to file
125-
- **Multi-Architecture** - Supports both x64 and ARM64 systems
120+
- 🎨 **30+ Visualizers** - JSON, XML, JWT, Base64, images, and many more
121+
- 🌳 **Multiple Views** - Raw, Formatted, Tree, Table, Hex, Rendered, and Image
122+
- 🖌️ **Syntax Highlighting** - Beautiful code highlighting via AvalonEdit
123+
- 🔎 **Search** - Find text within large content (Ctrl+F)
124+
- 📋 **Copy & Export** - Copy raw/formatted content or export to file
125+
- 🖥️ **Multi-Architecture** - Supports both x64 and ARM64 systems
126126

127-
## Visualizer Catalog
127+
## 📦 Visualizer Catalog
128128

129-
### Data Formats
129+
### 📄 Data Formats
130130

131131
| Visualizer | Description | Views |
132132
|------------|-------------|-------|
@@ -141,7 +141,7 @@
141141
| **SQL** | Database queries | Formatted, Syntax Highlighted, Raw |
142142
| **GraphQL** | API queries | Formatted, Syntax Highlighted, Raw |
143143

144-
### Encoded Data
144+
### 🔤 Encoded Data
145145

146146
| Visualizer | Description | Views |
147147
|------------|-------------|-------|
@@ -153,15 +153,15 @@
153153
| **Hex String** | `48656C6C6F``Hello` | Decoded, Hex, Raw |
154154
| **GZip/Deflate** | Compressed payloads | Decompressed, Raw |
155155

156-
### Security & Auth Tokens
156+
### 🔐 Security & Auth Tokens
157157

158158
| Visualizer | Description | Views |
159159
|------------|-------------|-------|
160160
| **JWT** | Decode header, payload, expiry | Claims Table, Decoded, Raw |
161161
| **SAML** | Decode assertions | XML Tree, Claims, Raw |
162162
| **X.509 Certificate** | PEM/DER certificates | Details Table, Raw |
163163

164-
### Structured Strings
164+
### 🔗 Structured Strings
165165

166166
| Visualizer | Description | Views |
167167
|------------|-------------|-------|
@@ -171,7 +171,7 @@
171171
| **Regex** | Pattern visualization | Pattern Breakdown, Raw |
172172
| **Cron Expression** | Schedule expressions | Human Readable, Next Runs |
173173

174-
### Binary & Low-Level
174+
### 💾 Binary & Low-Level
175175

176176
| Visualizer | Description | Views |
177177
|------------|-------------|-------|
@@ -180,7 +180,7 @@
180180
| **Timestamp** | Unix epoch conversion | Human Readable, UTC/Local |
181181
| **IP Address** | IPv4/IPv6 details | Formatted, CIDR Info |
182182

183-
## Installation
183+
## 🛠️ Installation
184184

185185
### Visual Studio Marketplace
186186

@@ -193,7 +193,7 @@
193193

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

196-
## Usage
196+
## 🚀 Usage
197197

198198
1. Set a breakpoint where a string variable is in scope
199199
2. When the debugger hits the breakpoint, hover over the variable
@@ -207,14 +207,14 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
207207
<em>Select a visualizer from the list</em>
208208
</p>
209209

210-
### Keyboard Shortcuts
210+
### ⌨️ Keyboard Shortcuts
211211

212212
| Shortcut | Action |
213213
|----------|--------|
214214
| `Ctrl+F` | Search within content |
215215
| `Escape` | Close visualizer window |
216216

217-
### Toolbar Actions
217+
### 🛠️ Toolbar Actions
218218

219219
| Button | Action |
220220
|--------|--------|
@@ -223,12 +223,12 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
223223
| **Export** | Save content to a file |
224224
| **Word Wrap** | Toggle word wrapping |
225225

226-
## Requirements
226+
## 📋 Requirements
227227

228-
- Visual Studio 2022 (17.8) or later
229-
- .NET Framework 4.8
228+
- 💻 Visual Studio 2022 (17.8) or later
229+
- 🔧 .NET Framework 4.8
230230

231-
## Technology Stack
231+
## 🏗️ Technology Stack
232232

233233
| Component | Technology |
234234
|-----------|------------|
@@ -241,24 +241,24 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
241241
| Cron Parsing | NCrontab |
242242
| CSV Parsing | CsvHelper |
243243

244-
## Contributing
244+
## 🤝 Contributing
245245

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

248-
### Development Setup
248+
### 🔧 Development Setup
249249

250250
1. Clone the repository
251251
2. Open the solution in Visual Studio 2022 or 2026
252252
3. Ensure you have the "Visual Studio extension development" workload installed
253253
4. Press F5 to launch the experimental instance
254254

255-
## License
255+
## 📄 License
256256

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

259259
---
260260

261-
## Contributors
261+
## 👥 Contributors
262262

263263
<!-- readme: contributors -start -->
264264
<!-- readme: contributors -end -->

0 commit comments

Comments
 (0)