Skip to content

Commit 1420f5a

Browse files
authored
docs(readme): add emojis and standardize workflows (#71)
1 parent ea17324 commit 1420f5a

File tree

4 files changed

+13
-41
lines changed

4 files changed

+13
-41
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/[email protected] @commitlint/[email protected]
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: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
Tired of the tedious, error-prone process of renaming a project in Visual Studio? Say goodbye to manual find-and-replace across dozens of files! **Project Renamifier** handles everything automatically - one click, one dialog, done!
3838

39-
## Features
39+
## Features
4040

4141
When you rename a project, this extension handles **all** of the following automatically:
4242

@@ -53,13 +53,13 @@ When you rename a project, this extension handles **all** of the following autom
5353

5454
The extension shows a progress dialog with step-by-step status as it performs the rename operation, and includes error handling with rollback support if something goes wrong.
5555

56-
## Screenshots
56+
## 📸 Screenshots
5757

5858
![Rename Dialog](https://raw.githubusercontent.com/CodingWithCalvin/VS-ProjectRenamifier/main/resources/rename-dialog.png)
5959

6060
![Progress Dialog](https://raw.githubusercontent.com/CodingWithCalvin/VS-ProjectRenamifier/main/resources/progress-dialog.png)
6161

62-
## Installation
62+
## 🛠️ Installation
6363

6464
### Visual Studio Marketplace
6565

@@ -72,39 +72,39 @@ The extension shows a progress dialog with step-by-step status as it performs th
7272

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

75-
## Usage
75+
## 🚀 Usage
7676

7777
1. Right-click on a project in Solution Explorer
7878
2. Select **Renamify Project**
7979
3. Enter the new project name in the dialog
8080
4. Click **Rename** and watch the magic happen!
8181

82-
## Supported Versions
82+
## 💻 Supported Versions
8383

8484
| Visual Studio | Architectures |
8585
|---------------|---------------|
8686
| Visual Studio 2022 (17.x) | x64 (amd64), ARM64 |
8787
| Visual Studio 2026 (18.x) | x64 (amd64), ARM64 |
8888

89-
## Contributing
89+
## 🤝 Contributing
9090

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

93-
### Development Setup
93+
### 🔧 Development Setup
9494

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

101-
## License
101+
## 📄 License
102102

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

105105
---
106106

107-
## Contributors
107+
## 👥 Contributors
108108

109109
<!-- readme: contributors -start -->
110110
<!-- readme: contributors -end -->

0 commit comments

Comments
 (0)