terence.carrera/wizgit-vscode-extension
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

fix: Standardize formatting in README.md for better readability

Browse Source
This commit is contained in:
Terence Carrera
2025-12-17 16:15:08 +08:00
parent 99c4117193
commit 3f04933b3b
1 changed files with 56 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
README.md
View File

@@ -8,47 +8,54 @@ Your intelligent coding companion for comprehensive repository management, right
## Features ## Features
### 🏠 **Dedicated Activity Bar** ### 🏠 **Dedicated Activity Bar**
* **Custom WizGIT sidebar** with organized views for repositories, issues, and pull requests
* **Quick access** to all WizGIT functionality from the activity bar * **Custom WizGIT sidebar** with organized views for repositories, issues, and pull requests
* **Quick access** to all WizGIT functionality from the activity bar
### 📁 **Repository Management** ### 📁 **Repository Management**
* **Create repositories:** Easily create new repositories on WizGit directly from VS Code
* **Clone repositories:** Clone existing repositories with integrated UI * **Create repositories:** Easily create new repositories on WizGit directly from VS Code
* **Repository discovery:** Automatic workspace detection and repository listing * **Clone repositories:** Clone existing repositories with integrated UI
* **Refresh functionality:** Keep your repository list up-to-date * **Repository discovery:** Automatic workspace detection and repository listing
* **Refresh functionality:** Keep your repository list up-to-date
### 🐛 **Issue Management** ### 🐛 **Issue Management**
* **Create issues:** Create new issues with intelligent workspace auto-detection
* **Repository auto-detection:** Automatically populate organization and repository from your workspace * **Create issues:** Create new issues with intelligent workspace auto-detection
* **Branch selection:** Choose target branch from a list of available branches (local and remote) * **Repository auto-detection:** Automatically populate organization and repository from your workspace
* **Context integration:** Create issues from file explorer or editor context menu * **Branch selection:** Choose target branch from a list of available branches (local and remote)
* **Context integration:** Create issues from file explorer or editor context menu
### 🔀 **Pull Request Management** ### 🔀 **Pull Request Management**
* **Create pull requests:** Create PRs with comprehensive file change detection
* **File changes display:** View detailed file modifications and diffs * **Create pull requests:** Create PRs with comprehensive file change detection
* **Smart branch selection:** Choose source and destination branches with intelligent defaults * **File changes display:** View detailed file modifications and diffs
* **Workspace integration:** Auto-detect repository information from your current workspace * **Smart branch selection:** Choose source and destination branches with intelligent defaults
* **Workspace integration:** Auto-detect repository information from your current workspace
### 🔐 **Authentication & Security** ### 🔐 **Authentication & Security**
* **Secure token storage:** Safely store and manage your WizGit Personal Access Token
* **Configuration management:** Easy setup and configuration clearing options * **Secure token storage:** Safely store and manage your WizGit Personal Access Token
* **API endpoint flexibility:** Support for custom WizGit/Gitea instances * **Configuration management:** Easy setup and configuration clearing options
* **API endpoint flexibility:** Support for custom WizGit/Gitea instances
### ⚙️ **Smart Features** ### ⚙️ **Smart Features**
* **Workspace detection:** Automatically identify Git repositories and extract owner/repo information
* **Branch enumeration:** List and select from available local and remote branches * **Workspace detection:** Automatically identify Git repositories and extract owner/repo information
* **Progress tracking:** Visual progress indication during operations * **Branch enumeration:** List and select from available local and remote branches
* **Error handling:** Comprehensive error reporting and troubleshooting * **Progress tracking:** Visual progress indication during operations
* **Error handling:** Comprehensive error reporting and troubleshooting
## Requirements ## Requirements
* Visual Studio Code v1.74.0 or newer. * Visual Studio Code v1.74.0 or newer.
* A valid WizGit account with API access. * A valid WizGit account with API access.
* Personal Access Token from your WizGit instance. * Personal Access Token from your WizGit instance.
## Getting Started ## Getting Started
### Initial Setup ### Initial Setup
1. **Configure WizGIT:** Open Command Palette (`Ctrl+Shift+P`) and run `WizGIT: Configure WizGIT` 1. **Configure WizGIT:** Open Command Palette (`Ctrl+Shift+P`) and run `WizGIT: Configure WizGIT`
2. **Enter your details:** 2. **Enter your details:**
- WizGit API endpoint (e.g., `https://your-wizgit-instance.com/api/v1`) - WizGit API endpoint (e.g., `https://your-wizgit-instance.com/api/v1`)
@@ -56,23 +63,27 @@ Your intelligent coding companion for comprehensive repository management, right
3. **Access the sidebar:** Click the WizGIT icon in the activity bar to open the dedicated sidebar 3. **Access the sidebar:** Click the WizGIT icon in the activity bar to open the dedicated sidebar
### Creating Repositories ### Creating Repositories
1. In the WizGIT sidebar, go to the **Repositories** view 1. In the WizGIT sidebar, go to the **Repositories** view
2. Click the "Create Repository" button (➕) in the title bar 2. Click the "Create Repository" button (➕) in the title bar
3. Fill in repository details and click "Create Repository" 3. Fill in repository details and click "Create Repository"
### Managing Issues ### Managing Issues
1. In the **Issues** view, click "Create Issue" (🐛) 1. In the **Issues** view, click "Create Issue" (🐛)
2. The extension will automatically detect your workspace repository 2. The extension will automatically detect your workspace repository
3. Choose the target branch from the dropdown list 3. Choose the target branch from the dropdown list
4. Fill in issue title and description, then submit 4. Fill in issue title and description, then submit
### Creating Pull Requests ### Creating Pull Requests
1. In the **Pull Requests** view, click "Create Pull Request" (🔀) 1. In the **Pull Requests** view, click "Create Pull Request" (🔀)
2. Select source and destination branches 2. Select source and destination branches
3. Review the automatically detected file changes 3. Review the automatically detected file changes
4. Add title and description, then create the PR 4. Add title and description, then create the PR
### Alternative Access Methods ### Alternative Access Methods
- **Command Palette:** All commands are available via `Ctrl+Shift+P` - **Command Palette:** All commands are available via `Ctrl+Shift+P`
- **Context Menus:** Right-click in file explorer or editor to create issues - **Context Menus:** Right-click in file explorer or editor to create issues
- **Keyboard Shortcuts:** Assign custom shortcuts to frequently used commands - **Keyboard Shortcuts:** Assign custom shortcuts to frequently used commands
@@ -80,37 +91,40 @@ Your intelligent coding companion for comprehensive repository management, right
## Commands ## Commands
### Repository Commands ### Repository Commands
* `WizGIT: Configure WizGIT` - Set up API endpoint and authentication
* `WizGIT: Create Repository` - Create a new repository * `WizGIT: Configure WizGIT` - Set up API endpoint and authentication
* `WizGIT: Clone Repository` - Clone an existing repository * `WizGIT: Create Repository` - Create a new repository
* `WizGIT: Clear Configuration` - Remove stored authentication data * `WizGIT: Clone Repository` - Clone an existing repository
* `WizGIT: Clear Configuration` - Remove stored authentication data
### Issue & PR Commands ### Issue & PR Commands
* `WizGIT: Create Issue` - Create a new issue with workspace auto-detection
* `WizGIT: Create Pull Request` - Create a pull request with file change detection * `WizGIT: Create Issue` - Create a new issue with workspace auto-detection
* `WizGIT: Create Pull Request` - Create a pull request with file change detection
## Extension Settings ## Extension Settings
This extension contributes the following settings: This extension contributes the following settings:
* `wizgit.apiEndpoint` - Your WizGIT API endpoint URL * `wizgit.apiEndpoint` - Your WizGIT API endpoint URL
* `wizgit.autoDetect` - Automatically detect WizGIT repositories in workspace (default: `true`) * `wizgit.autoDetect` - Automatically detect WizGIT repositories in workspace (default: `true`)
* `wizgit.statusBar.enabled` - Show WizGIT information in status bar (default: `true`) * `wizgit.statusBar.enabled` - Show WizGIT information in status bar (default: `true`)
* `wizgit.notifications.enabled` - Enable WizGIT notifications (default: `true`) * `wizgit.notifications.enabled` - Enable WizGIT notifications (default: `true`)
* `wizgit.defaultBranch` - Default branch name for new repositories (default: `master`) * `wizgit.defaultBranch` - Default branch name for new repositories (default: `master`)
You can access these settings through VS Code's Settings UI or by adding them to your `settings.json`. You can access these settings through VS Code's Settings UI or by adding them to your `settings.json`.
## Known Issues ## Known Issues
* Network connectivity issues may cause API operations to fail * Network connectivity issues may cause API operations to fail
* File change detection for pull requests may not work with all repository configurations * File change detection for pull requests may not work with all repository configurations
* Workspace auto-detection requires a valid Git repository with remote origin configured * Workspace auto-detection requires a valid Git repository with remote origin configured
* Please report any bugs or feature requests on our [Issues page](http://126.209.24.132/terence.carrera/wizgit-vscode-extension/issues) * Please report any bugs or feature requests on our [Issues page](http://126.209.24.132/terence.carrera/wizgit-vscode-extension/issues)
## Release Notes ## Release Notes
### 0.0.4 (Current) ### 0.0.4 (Current)
* Bump version to 0.0.4 * Bump version to 0.0.4
* Fix issue with branch selection dropdown not populating correctly in some cases * Fix issue with branch selection dropdown not populating correctly in some cases
* Improve error messages for API failures during issue and pull request creation * Improve error messages for API failures during issue and pull request creation
@@ -118,11 +132,13 @@ You can access these settings through VS Code's Settings UI or by adding them to
* Enhance UI responsiveness during long-running operations with better progress indicators * Enhance UI responsiveness during long-running operations with better progress indicators
### 0.0.3 ### 0.0.3
* Bump version to 0.0.3 * Bump version to 0.0.3
### 0.0.2 ### 0.0.2
Major feature expansion and UI improvements: Major feature expansion and UI improvements:
* **New dedicated activity bar** with custom WizGIT sidebar * **New dedicated activity bar** with custom WizGIT sidebar
* **Issue management** with workspace auto-detection and branch selection * **Issue management** with workspace auto-detection and branch selection
* **Pull request creation** with file change detection and diff display * **Pull request creation** with file change detection and diff display
@@ -137,6 +153,7 @@ Major feature expansion and UI improvements:
### 0.0.1 ### 0.0.1
Initial release of WizGIT: Initial release of WizGIT:
* Core repository creation via WizGit API * Core repository creation via WizGit API
* Basic authentication and configuration * Basic authentication and configuration
* Progress tracking and error handling * Progress tracking and error handling