🤝 Contributing Guide

October 30, 2025 · View on GitHub

🎯 Ways to Contribute

🐛 Bug Fixes: Help improve plugin stability
✨ Feature Development: Add new AI features
📖 Documentation: Supplement technical documentation
🧪 Test Cases: Improve code coverage
🎓 Tutorial Writing: Share learning experiences

📚 Learning-Oriented Contributions

We especially welcome the following types of contributions:

AI concept explanation documents
In-depth technical analysis
Best practice case sharing
Performance optimization solutions
New model integration tutorials

🔧 Development Guide

Basic Workflow

Fork the project to your GitHub account
Create a feature branch (git checkout -b feature/AmazingFeature)
Commit your changes (git commit -m 'Add some AmazingFeature')
Push to the branch (git push origin feature/AmazingFeature)
Open a Pull Request

Development Environment Setup

Frontend Development Environment

# Clone the project
git clone https://github.com/your-org/voidmuse.git
cd voidmuse

# Install frontend dependencies
cd gui
npm install

# Start development server
npm run dev

VS Code Extension Development

# Install VS Code extension dependencies
cd extensions/vscode
npm install

# Compile the extension
npm run compile

# Start debugging (Press F5)

IntelliJ Plugin Development

# Build IntelliJ plugin
cd extensions/intellij
./gradlew buildPlugin

# Run the plugin
./gradlew runIde

📋 Development Standards

Code Standards

Development Environment Setup (see above sections)
Coding Standards (follow existing code style)
Documentation Writing Standards (clear and comprehensive)
Testing Guide (add tests for new features)
Commit Message Standards (see below)

Commit Standards

We use Conventional Commits specification:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Type Descriptions

feat: New feature
fix: Bug fix
docs: Documentation update
style: Code formatting adjustment
refactor: Code refactoring
test: Test-related
chore: Build process or auxiliary tool changes

Examples

feat(ai-chat): add Claude model support
fix(embedding): resolve vector search timeout issue
docs(readme): update installation instructions

Code Review Guidelines

For Contributors

Ensure code follows project conventions
Write clear commit messages
Add tests for new features
Update documentation as needed
Respond to review feedback promptly

For Reviewers

Be constructive and respectful
Focus on code quality and maintainability
Check for security vulnerabilities
Verify test coverage
Ensure documentation is updated

🧪 Testing Guidelines

Test Types

Unit Tests: Test individual functions and components
Integration Tests: Test component interactions
E2E Tests: Test complete user workflows
Performance Tests: Verify performance requirements

Running Tests

# Frontend tests
cd gui
npm run test
npm run test:e2e

# VSCode extension tests
cd extensions/vscode
npm run test

# IntelliJ plugin tests
cd extensions/intellij
./gradlew test