Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (40 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.81 KB

🤝 Contributing Guide

Thank you for your interest in VirtualTabs (editorGrouper)! We welcome all forms of contribution, whether it's fixing bugs, developing new features, or improving documentation.

🤖 AI-Assisted Development Guide for Contributors

If you use AI tools (such as Cursor, Copilot, ChatGPT, or Claude) to assist with your development, we have prepared a specific prompt for you. Before writing code or submitting a Pull Request (PR), we highly recommend pasting the following prompt to your AI assistant. This will significantly improve your development experience and the chances of your PR being merged quickly.

📝 AI Prompt (Copy and paste to your AI)

Click to expand AI Developer Prompt 
You are now a senior contributor to the VirtualTabs project. When I develop/modify code and prepare a PR, please strictly adhere to the following guidelines:

1. **Development Rules**:
   - The project is a VS Code Extension based on TypeScript.
   - Please use English for all internal code comments and documentation updates.
   - When adding new features, ensure they comply with the settings in `package.json` and the i18n specifications in `package.nls.json`.
   
2. **Commit Message Format**:
   - Please follow the Conventional Commits specification (feat, fix, docs, chore, etc.).
   - Example: `feat(core): add new group management feature`

3. **Pull Request Description Generation**:
   - When I finish coding and ask you to formulate a PR description, you must generate it according to the structure defined in `.github/PULL_REQUEST_TEMPLATE.md`.
   - The content must explicitly state "what problem is solved", "which core files were modified", and "how to manually test this feature".

🛠 Development Workflow

  1. Fork this repository and clone it to your local machine.
  2. Create a new development branch (e.g., feature/my-new-feature or bugfix/issue-123).
  3. Refer to DEVELOPMENT.md for local environment setup and architecture understanding.
  4. Commit your changes following our commit conventions.
  5. Push the branch and create a Pull Request.

📝 Code Style

  • Use TypeScript strict mode.
  • Follow existing naming conventions.
  • Use JSDoc comments appropriately for main functions and classes.

✅ Testing Checklist

Before submitting a PR, please ensure your changes pass the following basic checks:

  • TypeScript compiles without errors (npm run vscode:prepublish)
  • All features work properly in the VS Code Extension Development Host
  • New features do not break existing Drag-and-drop, Context menu, and Multi-selection functionality
  • Auto-grouping and group management features work as expected

If you have any questions about the architecture or design, feel free to open an Issue to discuss!