diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..97d9df5 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing to Vue Class Component + +Thank you for contributing to Vue Class Component! To manage the process smoothly, please take a look at the following points. + +## Issue Reporting + +Please make sure that your issue is either a **bug report** or **feature request**. The other kinds of issue will be closed immediately. For usage questions, +please use [Stack Overflow](https://stackoverflow.com/), [the official Vue.js forum](https://forum.vuejs.org), [the official Discord server](https://chat.vuejs.org), etc. + +Also, please try searching existing issue before creating a new one. Your issue may exist already in an old thread. + +### Bug Report + +Please **make sure to provide [minimal and self-contained reproduction](https://new-issue.vuejs.org/?repo=vuejs/vue#why-repro)**. +A bug report without a proper reproduction may be closed immediately. + +To create a reproduction, you can use on-browser playground such as JSFiddle ([template for Vue Class Component](https://jsfiddle.net/ktsn/nm55jnjk/)) +or create a GitHub repository and share its link. + +Please also clarify the expected behavior, actual behavior and steps to reproduce the bug to confirm it precisely. + +### Feature Request + +For feature request, please make sure to clarify **the use case** that you want to solve. +Explaining it with actual code example or pseudo code would be useful to share your idea. + +## Pull Request + +Please do not commit the files under `dist/`. They are supporsed to be generated during the releasing process. diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000..e0f161e --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,15 @@ +tasks: + - name: Compile + init: yarn install && yarn build && gp sync-done install + command: yarn dev + - name: Docs + init: gp sync-await install + command: yarn docs:dev + +ports: + - port: 8080 + onOpen: open-preview + +vscode: + extensions: + - octref.vetur@0.23.0:TEzauMObB6f3i2JqlvrOpA== diff --git a/README.md b/README.md index 32ffe39..d1d2a00 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,33 @@ -# Vue Class Component +# [DEPRECATED] Vue Class Component + + +## ⚠️ Notice + +This library is no longer actively maintained. It is no longer recommend to use Class-based components in Vue 3. The recommended way to use Vue 3 in large applications is Single-File Components, Composition API, and `