Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
45 lines (31 loc) 路 1.18 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) 路 1.18 KB
Raw

Contributing to Vue Plugin Template

Thank you for your interest in contributing! Here are some guidelines to help you get started.

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/vue-plugin-template.git
  3. Install dependencies: npm install
  4. Create a branch: git checkout -b feature/your-feature

Development Workflow

  1. Make your changes in the appropriate directory:

    • src/ for plugin code
    • tests/ for tests
    • playground/ for playground examples

  2. Run tests: npm run test

  3. Run linter: npm run lint

  4. Format code: npm run format

Testing

  • Write tests for any new features
  • Ensure all tests pass before submitting
  • Aim for high test coverage

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Ensure all tests pass and code is linted
  3. Update the version number if applicable
  4. Submit your PR with a clear description of the changes

Code Style

  • Follow the existing code style
  • Use TypeScript for all new code
  • Write clear, descriptive commit messages
  • Add comments for complex logic

Questions?

Feel free to open an issue for any questions or concerns.