Reporting Issues
If you encounter a bug or have an idea for a new feature, please create an issue in our repository.Be sure to provide all necessary information, such as details about the problem or the new functionality you’re suggesting. Include:
- Steps to reproduce the issue
- Expected vs actual behavior
- Screenshots or error messages if applicable
- Your VS Code version and extension version
Contributing Code
If you want to contribute code, follow these steps:Step 1: Fork the Repository
Step 1: Fork the Repository
Fork the ‘View Exports SVG’ repository to your GitHub account.
Step 2: Clone Your Fork
Step 2: Clone Your Fork
Clone your fork to your local machine:
Step 3: Create a Branch
Step 3: Create a Branch
Create a branch for your contribution:Use descriptive branch names:
feature/for new featuresfix/for bug fixesdocs/for documentation updatesrefactor/for code refactoring
Step 4: Make Your Changes
Step 4: Make Your Changes
Make your changes and ensure you follow the project’s coding style and best practices.Coding Standards:
- The project uses Biome for linting and formatting (replaces ESLint and Prettier)
- Follow the existing code style and conventions
- Write clear, descriptive commit messages
- Add comments for complex logic
- Ensure your code is compatible with the minimum VSCode version (
^1.109.0)
Step 5: Commit Your Changes
Step 5: Commit Your Changes
Commit your changes with a descriptive message:Commit Message Guidelines:
- Use the imperative mood (“Add feature” not “Added feature”)
- Be concise but descriptive
- Reference issue numbers when applicable
Step 6: Push to Your Fork
Step 6: Push to Your Fork
Push your changes to your fork:
Step 7: Open a Pull Request
Step 7: Open a Pull Request
Open a Pull Request in our main repository.PR Guidelines:
- Describe your changes in detail
- Provide context for your contribution
- Link to any related issues
- Include screenshots or videos for UI changes
- Ensure all tests pass
Local Development
If you want to run the extension in your local environment to test your changes, follow these steps:Setup
1. Clone the Repository
1. Clone the Repository
2. Install Dependencies
2. Install Dependencies
3. Build the Webview UI
3. Build the Webview UI
4. Compile the Extension
4. Compile the Extension
5. Launch Extension
5. Launch Extension
Press
F5 to start a new instance of Visual Studio Code with the extension loaded.Development Scripts
npm run biome:format- Auto-format code using Biomenpm run biome:lint- Run linternpm run client:dev- Start Vite dev server with HMRnpm run client:build- Build webview UI for productionnpm run compile- Compile the extension
Development Requirements:
- Node.js 22.x (recommended)
- VS Code
^1.109.0or higher - Understanding of TypeScript and React
Contribution Guidelines
Code Quality
- Follow the project’s coding style (enforced by Biome)
- Write clean, maintainable code
- Add appropriate comments and documentation
- Test your changes thoroughly
Compatibility
- Ensure changes are compatible with the minimum VSCode version
- Test on multiple platforms if possible (Windows, macOS, Linux)
- Maintain backward compatibility when possible
Development Workflow
- Keep pull requests focused on a single feature or fix
- Write meaningful commit messages
- Update documentation when adding new features
- Follow the project’s branching strategy
Testing
- Test your changes in a development VS Code instance
- Verify the extension works with different file types and project structures
- Check for performance impacts
- Ensure no regressions in existing functionality
Getting Help
If you need help or have questions:- Check the official documentation
- Open an issue with the “question” tag
- Join discussions in existing issues and pull requests
Code of Conduct
Please note that this project follows our Code of Conduct. By participating, you are expected to uphold this code.Thank you for contributing to View Exports SVG! Your efforts help make this extension better for everyone.