Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

23 lines (12 loc) · 1.76 KB

Nuxtr contributing guide

The goal is to offer the best developer experience for Nuxt developers within VSCode. We're open to any suggestions and ideas that can help us achieve that goal.

One of the main challenges is to keep the extension as lightweight as possible. We want to avoid adding too many features that can be easily achieved with other extensions. We want to avoid turning Nuxtr into an opinionated extension that tries to do everything. Any features we already have that can be labeled as "opinionated" should be optional and should be justified by a good reason why adding it will improve the developer experience.

As part of our roadmap we're exploring the options of building separate extensions that be used on top of Nuxtr VSCode or offering APIs that can be used by other extensions.

Repo

Nuxtr VSCode contains a typical VSCode extension structure with sidebar logic written using Vue 3 + TypeScript project and imported using WebViews.

We're using PNPM, so make sure you have it installed. Here's a quick guide on how to install it.

PRs

Discuss first

We're always happy to have contributors to the project. Nuxtr is actively developed and we want to avoid wasting time and effort. Starting a discussion first will help save time and effort for both maintainers and contributors.

Commit conventions

We use Conventional Commits to automate the release process. Please follow the commit conventions to make sure your PRs are included in the next release.