Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (65 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

88 lines (65 loc) · 2.67 KB

Contributing to vue-sfc-format.nvim

First off, thank you for considering contributing to vue-sfc-format.nvim! It's people like you who make the Neovim ecosystem better.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please search the issue tracker to see if the problem has already been reported.

If you find a bug, please include:

  • Your Neovim version
  • Your configuration (the relevant part of your init.lua or init.vim)
  • Your .vue-sfc-format.json
  • A minimal reproducible example (a .vue file that fails to format correctly)
  • Expected vs. actual behavior

Suggesting Enhancements

Feature requests are welcome! Please open an issue and describe:

  • The problem this feature would solve
  • How you imagine the feature working
  • Any alternatives you've considered

Pull Requests

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/my-new-feature)
  3. Make your changes
  4. Ensure tests pass and code style is maintained
  5. Update documentation (doc/vue-sfc-format.txt) if you've added or changed features
  6. Commit your changes following the Conventional Commits format
  7. Push to the branch (git push origin feature/my-new-feature)
  8. Create a new Pull Request

Commit Message Format

This project follows the Conventional Commits specification.

<type>: <description>

Types:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation changes
  • style: Code style changes (formatting, whitespace)
  • refactor: Code refactoring without feature changes
  • perf: Performance improvements
  • test: Adding or updating tests
  • build: Build system or dependency changes
  • ci: CI/CD configuration changes
  • chore: Maintenance tasks

Examples:

feat: add support for custom script formatters
fix: resolve parsing error with nested template tags
docs: update configuration examples in README
refactor: simplify section extraction logic

Development Setup

Testing

This project uses vusted for testing.

To run tests locally:

  1. Install vusted
  2. Run vusted tests/

Code Style

We use Stylua for Lua code formatting. Please ensure your code follows the project's style by running:

stylua .

We also use luacheck for linting.

luacheck .

Community

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.