Skip to content

Commit 0466cc6

Browse files
authored
docs(readme): add emojis and standardize workflows (#31)
* 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 b0294df commit 0466cc6

4 files changed

Lines changed: 17 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: 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: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@
3636

3737
A Visual Studio 2022/2026 extension that adds a right-click context menu command to open the project's bin folder. It intelligently uses the currently active solution/project configuration to navigate to the correct output folder (Debug, Release, etc.).
3838

39-
## Features
39+
## Features
4040

41-
- **Right-click to open** - Simple context menu integration in Solution Explorer
42-
- **Configuration-aware** - Opens the correct bin folder based on your active build configuration
43-
- **Lightning fast** - No settings, no dialogs, just works!
41+
- 🖱️ **Right-click to open** - Simple context menu integration in Solution Explorer
42+
- ⚙️ **Configuration-aware** - Opens the correct bin folder based on your active build configuration
43+
- **Lightning fast** - No settings, no dialogs, just works!
4444

45-
## Installation
45+
## 🛠️ Installation
4646

4747
### Visual Studio Marketplace
4848

@@ -55,37 +55,37 @@ A Visual Studio 2022/2026 extension that adds a right-click context menu command
5555

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

58-
## Usage
58+
## 🚀 Usage
5959

6060
1. Right-click on any project in **Solution Explorer**
6161
2. Select **Open Bin Folder**
6262
3. Windows File Explorer opens to your project's output directory
6363

6464
That's it! The extension automatically detects your active configuration (Debug/Release) and opens the corresponding output folder.
6565

66-
## Requirements
66+
## 📋 Requirements
6767

68-
- Visual Studio 2022 (17.0) or later
69-
- .NET Framework 4.8
68+
- 💻 Visual Studio 2022 (17.0) or later
69+
- 🔧 .NET Framework 4.8
7070

71-
## Contributing
71+
## 🤝 Contributing
7272

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

75-
### Development Setup
75+
### 🔧 Development Setup
7676

7777
1. Clone the repository
7878
2. Open `src/CodingWithCalvin.OpenBinFolder.slnx` in Visual Studio 2022 or 2026
7979
3. Ensure you have the "Visual Studio extension development" workload installed
8080
4. Press F5 to launch the experimental instance
8181

82-
## License
82+
## 📄 License
8383

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

8686
---
8787

88-
## Contributors
88+
## 👥 Contributors
8989

9090
<!-- readme: contributors -start -->
9191
<!-- readme: contributors -end -->

0 commit comments

Comments
 (0)