Skip to content

Commit 6c91665

Browse files
authored
docs(readme): add emojis and standardize workflows (#43)
* 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 8b11a22 commit 6c91665

File tree

4 files changed

+16
-44
lines changed

4 files changed

+16
-44
lines changed

.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: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Lint Commit Messages
1+
name: Lint PR Title
22

33
on:
44
pull_request:
@@ -31,29 +31,3 @@ jobs:
3131
run: |
3232
echo "Validating PR title: $PR_TITLE"
3333
echo "$PR_TITLE" | npx commitlint --verbose
34-
35-
commitlint:
36-
name: Lint Commit Messages
37-
runs-on: ubuntu-latest
38-
steps:
39-
- name: Checkout code
40-
uses: actions/checkout@v4
41-
with:
42-
fetch-depth: 0 # Fetch all history for all branches and tags
43-
44-
- name: Setup Node.js
45-
uses: actions/setup-node@v4
46-
with:
47-
node-version: '20'
48-
49-
- name: Install commitlint
50-
run: |
51-
npm install --save-dev @commitlint/cli@18.4.3 @commitlint/config-conventional@18.4.3
52-
53-
- name: Validate PR commits
54-
run: |
55-
# Get the base branch (usually main)
56-
BASE_SHA=$(git merge-base origin/${{ github.base_ref }} HEAD)
57-
58-
# Lint all commits in the PR
59-
npx commitlint --from $BASE_SHA --to HEAD --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

README.md

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

3535
---
3636

37-
## Features
37+
## Features
3838

39-
- **Right-click to open** - Open any file directly from Solution Explorer
40-
- **Works everywhere** - Solutions, projects, folders, and individual files
41-
- **Auto-detection** - Automatically finds Notepad++ in the default install location
42-
- **Configurable** - Custom executable path via Tools > Options
39+
- 🖱️ **Right-click to open** - Open any file directly from Solution Explorer
40+
- 🌐 **Works everywhere** - Solutions, projects, folders, and individual files
41+
- 🔍 **Auto-detection** - Automatically finds Notepad++ in the default install location
42+
- ⚙️ **Configurable** - Custom executable path via Tools > Options
4343

44-
## Prerequisites
44+
## 📋 Prerequisites
4545

4646
This extension requires [Notepad++](https://notepad-plus-plus.org/) to be installed on your machine.
4747

48-
## Installation
48+
## 🛠️ Installation
4949

5050
### Visual Studio Marketplace
5151

@@ -58,28 +58,28 @@ This extension requires [Notepad++](https://notepad-plus-plus.org/) to be instal
5858

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

61-
## Configuration
61+
## ⚙️ Configuration
6262

6363
The extension automatically detects `notepad++.exe` in the default installation directory. If you've installed Notepad++ to a custom location, configure the path in **Tools > Options > Open in Notepad++**.
6464

65-
## Contributing
65+
## 🤝 Contributing
6666

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

69-
### Development Setup
69+
### 🔧 Development Setup
7070

7171
1. Clone the repository
7272
2. Open `src/CodingWithCalvin.OpenInNotepadPlusPlus.slnx` in Visual Studio 2022 or 2026
7373
3. Ensure you have the "Visual Studio extension development" workload installed
7474
4. Press F5 to launch the experimental instance
7575

76-
## License
76+
## 📄 License
7777

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

8080
---
8181

82-
## Contributors
82+
## 👥 Contributors
8383

8484
<!-- readme: contributors -start -->
8585
<!-- readme: contributors -end -->

0 commit comments

Comments
 (0)