Add community files and GitHub templates

matiyas · claude · matiyas · commit 39bf0e5b139a · 2026-02-27T08:35:07.000+01:00
Co-Authored-By: Claude Opus 4.5 &lt;noreply@anthropic.com&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Open a `.vue` file with specific content
+2. Run `:VueSfcFormat` or trigger format on save
+3. See error or unexpected formatting
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Neovim version: [e.g. 0.9.5, nightly]
+ - OS: [e.g. macOS, Linux, Windows]
+ - Plugin version: [e.g. 1.0.0]
+
+**Additional context**
+Add any other context about the problem here (e.g. your `.vue-sfc-format.json`).
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,32 @@
+## Description
+
+Please include a summary of the changes and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+
+- [ ] Existing tests passed
+- [ ] New tests added (if applicable)
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and
+expression, level of experience, education, socio-economic status, nationality,
+personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,60 @@
+# 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](https://github.com/matiyas/vue-sfc-format.nvim/issues) 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 (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin feature/my-new-feature`)
+8. Create a new Pull Request
+
+## Development Setup
+
+### Testing
+
+This project uses [vusted](https://github.com/notomo/vusted) for testing.
+
+To run tests locally:
+1. Install `vusted`
+2. Run `vusted tests/`
+
+### Code Style
+
+We use [Stylua](https://github.com/JohnnyMorganz/StyLua) for Lua code formatting. Please ensure your code follows the project's style by running:
+```bash
+stylua .
+```
+
+We also use [luacheck](https://github.com/mpeterv/luacheck) for linting.
+```bash
+luacheck .
+```
+
+## Community
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
diff --git a/README.md b/README.md
@@ -209,3 +209,9 @@ export default {
 ## License
 
 MIT
+
+## Community
+
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Contributing](CONTRIBUTING.md)
+- [Security Policy](SECURITY.md)
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions
+
+The following versions of `vue-sfc-format.nvim` are currently being supported with security updates.
+
+| Version | Supported |
+| ------- | --------- |
+| 1.0.x   | ✅         |
+| < 1.0   | ❌         |
+
+## Reporting a Vulnerability
+
+We take security seriously and want to ensure that our project is as secure as possible. If you find a security vulnerability, please do not disclose it publicly. Instead, please report it via the project's [GitHub Security Advisory](https://github.com/matiyas/vue-sfc-format.nvim/security/advisories/new) feature or by contacting the project maintainer directly.
+
+We will acknowledge your report within 48 hours and provide a timeline for addressing the issue. Once the vulnerability has been fixed, we will issue a new release and provide an advisory with details about the fix and any necessary actions for users.
+
+Please include as much information as possible in your report, including:
+- A description of the vulnerability
+- Steps to reproduce the issue
+- Potential impact of the vulnerability
+- Any suggested fixes or workarounds
+
+Thank you for helping us keep our community safe.
