You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/about/coc.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
# Code Of Conduct
1
+
# Code Of Conduct {#code-of-conduct}
2
2
3
-
## Our Pledge
3
+
## Our Pledge {#our-pledge}
4
4
5
5
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, political party, or sexual identity and orientation. Note, however, that religion, political party, or other ideological affiliation provide no exemptions for the behavior we outline as unacceptable in this Code of Conduct.
6
6
7
-
## Our Standards
7
+
## Our Standards {#our-standards}
8
8
9
9
Examples of behavior that contributes to creating a positive environment include:
10
10
@@ -22,23 +22,23 @@ Examples of unacceptable behavior by participants include:
22
22
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23
23
- Other conduct which could reasonably be considered inappropriate in a professional setting
24
24
25
-
## Our Responsibilities
25
+
## Our Responsibilities {#our-responsibilities}
26
26
27
27
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.
28
28
29
29
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.
30
30
31
-
## Scope
31
+
## Scope {#scope}
32
32
33
33
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.
34
34
35
-
## Enforcement
35
+
## Enforcement {#enforcement}
36
36
37
37
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. 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.
38
38
39
39
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.
40
40
41
-
## Attribution
41
+
## Attribution {#attribution}
42
42
43
43
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
- Follow our [team members](./team) on Twitter or GitHub.
21
21
- Follow the [RFC discussions](https://github.com/vuejs/rfcs).
22
22
- Subscribe to the [official blog](https://blog.vuejs.org/).
23
23
24
-
### Get Support
24
+
### Get Support {#get-support}
25
25
26
26
-[Discord Chat](https://chat.vuejs.org/): A place for Vue devs to meet and chat in real time.
27
27
-[Forum](https://forum.vuejs.org/): The best place to ask questions and get answers about Vue and its ecosystem.
@@ -30,49 +30,49 @@ Our [Code of Conduct](/about/coc) is a guide to make it easier to enrich all of
30
30
-[GitHub](https://github.com/vuejs): If you have a bug to report or feature to request, that's what the GitHub issues are for. Please respect the rules specified in each repository's issue template.
31
31
-[Twitter Community (unofficial)](https://twitter.com/i/communities/1516368750634840064): A Twitter community, where you can meet other Vue enthusiasts, get help, or just chat about Vue.
32
32
33
-
### Explore the Ecosystem
33
+
### Explore the Ecosystem {#explore-the-ecosystem}
34
34
35
35
-[The Awesome Vue Page](https://github.com/vuejs/awesome-vue): See what other awesome resources have been published by other awesome people.
36
36
-[Vue Telescope Explorer](https://vuetelescope.com/explore): Explore websites made with Vue, with insights on what framework / libraries they use.
37
37
-[Made with Vue.js](https://madewithvuejs.com/): showcases of projects and libraries made with Vue.
38
38
-[The "Show and Tell" Subforum](https://forum.vuejs.org/c/show-and-tell): Another great place to check out what others have built with and for the growing Vue ecosystem.
39
39
40
-
## What You Can Do
40
+
## What You Can Do {#what-you-can-do}
41
41
42
-
### Help Fellow Users
42
+
### Help Fellow Users {#help-fellow-users}
43
43
44
44
Code contribution is not the only form of contribution to the Vue community. Answering a question for a fellow Vue user on Discord or the forum is also considered a valuable contribution.
45
45
46
-
### Help Triage Issues
46
+
### Help Triage Issues {#help-triage-issues}
47
47
48
48
Triaging an issue means gathering missing information, running the reproduction, verifying the issue's validity, and investigating the cause of the issue.
49
49
50
50
We receive many issues in [our repositories on GitHub](https://github.com/vuejs) every single day. Our bandwidth is limited compared to the amount of users we have, so issue triaging alone can take an enormous amount of effort from the team. By helping us triage the issues, you are helping us become more efficient, allowing us to spend time on higher priority work.
51
51
52
52
You don't have to triage an issue with the goal of fixing it (although that would be nice too). Sharing the result of your investigation, for example the commit that led to the bug, can already save us a ton of time.
53
53
54
-
### Contribute Code
54
+
### Contribute Code {#contribute-code}
55
55
56
56
Contributing bug fixes or new features is the most direct form of contribution you can make.
57
57
58
58
The Vue core repository provides a [contributing guide](https://github.com/vuejs/core/blob/main/.github/contributing.md), which contains pull request guidelines and information regarding build setup and high-level architecture. Other sub-project repositories may also contain its own contribution guide - please make sure to read them before submitting pull requests.
59
59
60
60
Bug fixes are welcome at any time. For new features, it is best to discuss the use case and implementation details first in the [RFC repo](https://github.com/vuejs/rfcs/discussions).
61
61
62
-
### Share (and Build) Your Experience
62
+
### Share (and Build) Your Experience {#share-and-build-your-experience}
63
63
64
64
Apart from answering questions and sharing resources in the forum and chat, there are a few other less obvious ways to share and expand what you know:
65
65
66
66
-**Develop learning materials.** It's often said that the best way to learn is to teach. If there's something interesting you're doing with Vue, strengthen your expertise by writing a blog post, developing a workshop, or even publishing a gist that you share on social media.
67
67
-**Watch a repo you care about.** This will send you notifications whenever there's activity in that repository, giving you insider knowledge about ongoing discussions and upcoming features. It's a fantastic way to build expertise so that you're eventually able to help address issues and pull requests.
68
68
69
-
### Translate Docs
69
+
### Translate Docs {#translate-docs}
70
70
71
71
I hope that right now, you're reading this sentence in your preferred language. If not, would you like to help us get there?
72
72
73
73
See the [Translations guide](/translations/) for more details on how you can get involved.
74
74
75
-
### Become a Community Leader
75
+
### Become a Community Leader {#become-a-community-leader}
76
76
77
77
There's a lot you can do to help Vue grow in your community:
Vue is an independent, community-driven project. It was created by [Evan You](https://twitter.com/youyuxi) in 2014 as a personal side project. Today, Vue is actively maintained by [a team of both full-time and volunteer members from all around the world](/about/team), where Evan serves as the project lead. You can learn more about the story of Vue in this [documentary](https://www.youtube.com/watch?v=OrxmtDw4pVI).
6
6
7
7
Vue's development is primarily funded through sponsorships and we have been financially sustainable since 2016. If you or your business benefit from Vue, consider [sponsoring us](/sponsor/) to support Vue's development!
8
8
9
-
## What's the difference between Vue 2 and Vue 3?
9
+
## What's the difference between Vue 2 and Vue 3? {#what-s-the-difference-between-vue-2-and-vue-3}
10
10
11
11
Vue 3 is the current, latest major version of Vue. It contains new features that are not present in Vue 2, for example Teleport, Suspense, and multiple root elements per template. It also contains breaking changes that makes it incompatible with Vue 2. Full details are documented in the [Vue 3 Migration Guide](https://v3-migration.vuejs.org/).
12
12
@@ -22,21 +22,21 @@ If you intend to migrate an existing Vue 2 app to Vue 3, consult the [migration
22
22
23
23
Vue 2.7, which was shipped in July 2022, is the final minor release of the Vue 2 version range. Vue 2 has now entered maintenance mode: it will no longer ship new features, but will continue to receive critical bug fixes and security updates for 18 months starting from the 2.7 release date. This means **Vue 2 will reach End of Life by the end of 2023**. We believe this should provide plenty of time for most of the ecosystem to migrate over to Vue 3. However, we also understand that there could be teams or projects that cannot upgrade by this timeline while still needing to fulfill security and compliance requirements. We are planning to provide extended support for Vue 2 for teams with such needs - if your team expects to be using Vue 2 beyond the end of 2023, make sure to plan ahead and register your interest [here](https://airtable.com/shrj37Zf4ZIfrxFzh).
24
24
25
-
## What license does Vue use?
25
+
## What license does Vue use? {#what-license-does-vue-use}
26
26
27
27
Vue is a free and open source project released under the [MIT License](https://opensource.org/licenses/MIT).
28
28
29
-
## What browsers does Vue support?
29
+
## What browsers does Vue support? {#what-browsers-does-vue-support}
30
30
31
31
The latest version of Vue (3.x) only supports [browsers with native ES2015 support](https://caniuse.com/es6). This excludes IE11. Vue 3.x uses ES2015 features that cannot be polyfilled in legacy browsers, so if you need to support legacy browsers, you will need to use Vue 2.x instead.
32
32
33
-
## Is Vue reliable?
33
+
## Is Vue reliable? {#is-vue-reliable}
34
34
35
35
Vue is a mature and battle-tested framework. It is one of the most widely used JavaScript frameworks in production today, with over 1.5 million users worldwide, and is downloaded close to 10 million times a month on npm.
36
36
37
37
Vue is used in production by renowned organizations in varying capacities all around the world, including Wikimedia Foundation, NASA, Apple, Google, Microsoft, GitLab, Zoom, Tencent, Weibo, Bilibili, Kuaishou, and many more.
38
38
39
-
## Is Vue fast?
39
+
## Is Vue fast? {#is-vue-fast}
40
40
41
41
Vue 3 is one of the most performant mainstream frontend frameworks, and handles most web application use cases with ease, without the need for manual optimizations.
42
42
@@ -46,7 +46,7 @@ Do note that synthetic benchmarks like the above focus on raw rendering performa
46
46
47
47
You can learn more about how Vue automatically optimizes runtime performance in the [Rendering Mechanism](/guide/extras/rendering-mechanism.html) section, and how to optimize a Vue app in particularly demanding cases in the [Performance Optimization Guide](/guide/best-practices/performance.html).
48
48
49
-
## Is Vue lightweight?
49
+
## Is Vue lightweight? {#is-vue-lightweight}
50
50
51
51
When you use a build tool, many of Vue's APIs are ["tree-shakable"](https://developer.mozilla.org/en-US/docs/Glossary/Tree_shaking). For example, if you don't use the built-in `<Transition>` component, it won't be included in the final production bundle.
52
52
@@ -56,7 +56,7 @@ When using Vue without a build tool, we not only lose tree-shaking, but also hav
56
56
57
57
Some frameworks, such as Svelte, use a compilation strategy that produces extremely lightweight output in single-component scenarios. However, [our research](https://github.com/yyx990803/vue-svelte-size-analysis) shows that the size difference heavily depends on the number of components in the application. While Vue has a heavier baseline size, it generates less code per component. In real-world scenarios, a Vue app may very well end up being lighter.
58
58
59
-
## Does Vue scale?
59
+
## Does Vue scale? {#does-vue-scale}
60
60
61
61
Yes. Despite a common misconception that Vue is only suitable for simple use cases, Vue is perfectly capable of handling large scale applications:
62
62
@@ -68,25 +68,25 @@ Yes. Despite a common misconception that Vue is only suitable for simple use cas
68
68
69
69
- Lower barrier to entry and excellent documentation translate to lower onboarding and training costs for new developers.
70
70
71
-
## How do I contribute to Vue?
71
+
## How do I contribute to Vue? {#how-do-i-contribute-to-vue}
72
72
73
73
We appreciate your interest! Please check out our [Community Guide](/about/community-guide.html).
74
74
75
-
## Should I use Options API or Composition API?
75
+
## Should I use Options API or Composition API? {#should-i-use-options-api-or-composition-api}
76
76
77
77
If you are new to Vue, we provide a high-level comparison between the two styles [here](/guide/introduction.html#which-to-choose).
78
78
79
79
If you have previously used Options API and are currently evaluating Composition API, check out [this FAQ](/guide/extras/composition-api-faq).
80
80
81
-
## Should I use JavaScript or TypeScript with Vue?
81
+
## Should I use JavaScript or TypeScript with Vue? {#should-i-use-javascript-or-typescript-with-vue}
82
82
83
83
While Vue itself is implemented in TypeScript and provides first-class TypeScript support, it does not enforce an opinion on whether you should use TypeScript as a user.
84
84
85
85
TypeScript support is an important consideration when new features are added to Vue. APIs that are designed with TypeScript in mind are typically easier for IDEs and linters to understand, even if you aren't using TypeScript yourself. Everybody wins. Vue APIs are also designed to work the same way in both JavaScript and TypeScript as much as possible.
86
86
87
87
Adopting TypeScript involves a trade-off between onboarding complexity and long-term maintainability gains. Whether such a trade-off can be justified can vary depending on your team's background and project scale, but Vue isn't really an influencing factor in making that decision.
88
88
89
-
## How does Vue compare to Web Components?
89
+
## How does Vue compare to Web Components? {#how-does-vue-compare-to-web-components}
90
90
91
91
Vue was created before Web Components were natively available, and some aspects of Vue's design (e.g. slots) were inspired by the Web Components model.
We may ship incompatible changes to TypeScript definitions between **minor** versions. This is because:
44
44
@@ -48,29 +48,29 @@ We may ship incompatible changes to TypeScript definitions between **minor** ver
48
48
49
49
If you are using TypeScript, you can use a semver range that locks the current minor and manually upgrade when a new minor version of Vue is released.
50
50
51
-
### Compiled Code Compatibility with Older Runtime
51
+
### Compiled Code Compatibility with Older Runtime {#compiled-code-compatibility-with-older-runtime}
52
52
53
53
A newer **minor** version of Vue compiler may generate code that isn't compatible with the Vue runtime from an older minor version. For example, code generated by Vue 3.2 compiler may not be fully compatible if consumed by the runtime from Vue 3.1.
54
54
55
55
This is only a concern for library authors, because in applications, the compiler version and the runtime version is always the same. A version mismatch can only happen if you ship pre-compiled Vue component code as a package, and a consumer uses it in a project using an older version of Vue. As a result, your package may need to explicitly declare a minimum required minor version of Vue.
56
56
57
-
## Pre Releases
57
+
## Pre Releases {#pre-releases}
58
58
59
59
Minor releases typically go through a non-fixed number of beta releases. Major releases will go through an alpha phase and a beta phase.
60
60
61
61
Pre-releases are meant for integration / stability testing, and for early adopters to provide feedback for unstable features. Do not use pre-releases in production. All pre-releases are considered unstable and may ship breaking changes in between, so always pin to exact versions when using pre-releases.
62
62
63
-
## Deprecations
63
+
## Deprecations {#deprecations}
64
64
65
65
We may periodically deprecate features that have new, better replacements in minor releases. Deprecated features will continue to work, and will be removed in the next major release after it entered deprecated status.
66
66
67
-
## RFCs
67
+
## RFCs {#rfcs}
68
68
69
69
New features with substantial API surface and major changes to Vue will go through the **Request for Comments** (RFC) process. The RFC process is intended to provide a consistent and controlled path for new features to enter the framework, and give the users an opportunity to participate and offer feedback in the design process.
70
70
71
71
The RFC process is conducted in the [vuejs/rfcs](https://github.com/vuejs/rfcs) repo on GitHub.
72
72
73
-
## Experimental Features
73
+
## Experimental Features {#experimental-features}
74
74
75
75
Some features are shipped and documented in a stable version of Vue, but marked as experimental. Experimental features are typically features that have an associated RFC discussion with most of the design problems resolved on paper, but still lacking feedback from real world usage.
0 commit comments