Skip to content

Commit f9d5bb1

Browse files
authored
docs(readme): add emojis and standardize workflows (#27)
* 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 30eaf1b commit f9d5bb1

4 files changed

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

3737
Tired of lingering build artifacts causing mysterious issues? **Super Clean** nukes those `bin` and `obj` folders with a single click - no more hunting through folders manually!
3838

39-
## Features
39+
## Features
4040

4141
| Feature | Description |
4242
|---------|-------------|
@@ -46,7 +46,7 @@ Tired of lingering build artifacts causing mysterious issues? **Super Clean** nu
4646
| **Removes obj folder** | Deletes the entire `obj` directory and all its contents |
4747
| **Fast and reliable** | Quick deletion without the overhead of MSBuild's Clean target |
4848

49-
## Installation
49+
## 🛠️ Installation
5050

5151
### Visual Studio Marketplace
5252

@@ -59,38 +59,38 @@ Tired of lingering build artifacts causing mysterious issues? **Super Clean** nu
5959

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

62-
## Usage
62+
## 🚀 Usage
6363

6464
1. Right-click on a **Solution** or **Project** in Solution Explorer
6565
2. Select **Super Clean**
6666
3. Watch those `bin` and `obj` folders disappear!
6767

68-
## Supported Versions
68+
## 💻 Supported Versions
6969

7070
| Visual Studio | Architectures |
7171
|---------------|---------------|
7272
| Visual Studio 2022 (17.x) | x64 (amd64), ARM64 |
7373
| Visual Studio 2026 (18.x) | x64 (amd64), ARM64 |
7474

75-
## Contributing
75+
## 🤝 Contributing
7676

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

79-
### Development Setup
79+
### 🔧 Development Setup
8080

8181
1. Clone the repository
8282
2. Open the solution in Visual Studio 2022 or 2026
8383
3. Ensure you have the "Visual Studio extension development" workload installed
8484
4. Install the [Extensibility Essentials 2022](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) extension
8585
5. Press F5 to launch the experimental instance
8686

87-
## License
87+
## 📄 License
8888

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

9191
---
9292

93-
## Contributors
93+
## 👥 Contributors
9494

9595
<!-- readme: contributors -start -->
9696
<!-- readme: contributors -end -->

0 commit comments

Comments
 (0)