Skip to content

Commit 5b02a38

Browse files
authored
docs(readme): add emojis and standardize workflows (#352)
1 parent 0c8ca27 commit 5b02a38

4 files changed

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

3737
> **Note:** This extension is currently in **BETA / PREVIEW**. We're actively developing new features and would love your feedback!
3838
39-
## Features
39+
## Features
4040

4141
Couchbase Explorer brings powerful database management capabilities directly into your Visual Studio workflow:
4242

43-
### Connection Management
44-
- **Multiple Connections** - Save and manage connections to multiple Couchbase Server instances
45-
- **Secure Credential Storage** - Passwords are securely stored using Windows Credential Manager
46-
- **SSL/TLS Support** - Connect securely to your clusters with SSL encryption
47-
- **Connection Testing** - Verify your connection settings before saving
43+
### 🔌 Connection Management
44+
- 🔗 **Multiple Connections** - Save and manage connections to multiple Couchbase Server instances
45+
- 🔐 **Secure Credential Storage** - Passwords are securely stored using Windows Credential Manager
46+
- 🔒 **SSL/TLS Support** - Connect securely to your clusters with SSL encryption
47+
- **Connection Testing** - Verify your connection settings before saving
4848

49-
### Data Browsing
50-
- **Hierarchical Tree View** - Navigate your cluster structure: Buckets → Scopes → Collections → Documents
51-
- **Lazy Loading** - Efficient loading of large datasets with batched document retrieval
52-
- **Document Viewer** - View document contents in a formatted JSON editor with syntax highlighting
53-
- **Refresh Support** - Refresh any level of the tree to see the latest data
49+
### 🌳 Data Browsing
50+
- 📂 **Hierarchical Tree View** - Navigate your cluster structure: Buckets → Scopes → Collections → Documents
51+
- **Lazy Loading** - Efficient loading of large datasets with batched document retrieval
52+
- 📄 **Document Viewer** - View document contents in a formatted JSON editor with syntax highlighting
53+
- 🔄 **Refresh Support** - Refresh any level of the tree to see the latest data
5454

55-
### Document Operations
56-
- **View Documents** - Double-click or right-click to open documents in a dedicated editor tab
57-
- **Copy JSON** - Quickly copy document contents to clipboard
58-
- **Copy Document ID** - Copy document IDs for use in your code
55+
### 📝 Document Operations
56+
- 👁️ **View Documents** - Double-click or right-click to open documents in a dedicated editor tab
57+
- 📋 **Copy JSON** - Quickly copy document contents to clipboard
58+
- 🆔 **Copy Document ID** - Copy document IDs for use in your code
5959

60-
## Installation
60+
## 🛠️ Installation
6161

6262
### Visual Studio Marketplace
6363

@@ -70,14 +70,14 @@ Couchbase Explorer brings powerful database management capabilities directly int
7070

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

73-
## Usage
73+
## 🚀 Usage
7474

75-
### Opening Couchbase Explorer
75+
### 📂 Opening Couchbase Explorer
7676

7777
1. Go to **View > Couchbase Explorer**
7878
2. The tool window will appear (by default, docked near Server Explorer)
7979

80-
### Adding a Connection
80+
### Adding a Connection
8181

8282
1. Click the **Add Connection** button in the toolbar
8383
2. Enter a friendly name for your connection
@@ -87,18 +87,18 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
8787
6. Click **Test Connection** to verify
8888
7. Click **Save**
8989

90-
### Browsing Data
90+
### 🔍 Browsing Data
9191

9292
1. Right-click your connection and select **Connect**
9393
2. Expand the tree to browse: **Buckets > Scopes > Collections > Documents**
9494
3. Double-click any document to view its contents
9595

96-
## Requirements
96+
## 📋 Requirements
9797

98-
- **Visual Studio 2022** or **Visual Studio 2026** (x64 and ARM64 supported)
99-
- **Couchbase Server** 7.0+ or **Couchbase Capella** (Capella support coming soon)
98+
- 💻 **Visual Studio 2022** or **Visual Studio 2026** (x64 and ARM64 supported)
99+
- 🗄️ **Couchbase Server** 7.0+ or **Couchbase Capella** (Capella support coming soon)
100100

101-
## Roadmap
101+
## 🗺️ Roadmap
102102

103103
We're actively working on new features! Here's what's coming:
104104

@@ -111,28 +111,28 @@ We're actively working on new features! Here's what's coming:
111111

112112
Have a feature request? [Open an issue](https://github.com/CodingWithCalvin/VS-CouchbaseExplorer/issues/new)!
113113

114-
## Contributing
114+
## 🤝 Contributing
115115

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

118-
### Development Setup
118+
### 🔧 Development Setup
119119

120120
1. Clone the repository
121121
2. Open the solution in Visual Studio 2022 or 2026
122122
3. Ensure you have the "Visual Studio extension development" workload installed
123123
4. Press F5 to launch the experimental instance
124124

125-
## License
125+
## 📄 License
126126

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

129-
## Disclaimer
129+
## ⚠️ Disclaimer
130130

131131
This extension is an independent, community-driven project and is **not affiliated with, endorsed by, or sponsored by Couchbase, Inc.** Couchbase and Capella are trademarks of Couchbase, Inc.
132132

133133
---
134134

135-
## Contributors
135+
## 👥 Contributors
136136

137137
<!-- readme: contributors -start -->
138138
<!-- readme: contributors -end -->

0 commit comments

Comments
 (0)