mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-04 20:27:44 +08:00
chore: rm error doc (#10180)
This commit is contained in:
iamkun
GitHub
parent
51e6015b30
commit
ceef0a56ec
@ -1,90 +0,0 @@
|
||||
---
|
||||
title: Commit Examples
|
||||
lang: en-US
|
||||
---
|
||||
|
||||
# Commit Examples
|
||||
|
||||
## Why this chapter exists
|
||||
|
||||
Please refer to [Conventional Commits](https://www.conventionalcommits.org/) for more information.
|
||||
|
||||
A good commit message enables us:
|
||||
|
||||
1. To understand what the contributor is trying to do
|
||||
2. Automatically generates change log
|
||||
|
||||
### Rule for writing commit message
|
||||
|
||||
```md
|
||||
# (If applied, this commit will...) <subject> (Max 72 characters)
|
||||
|
||||
# |<---- Using a Maximum Of 72 Characters ---->|
|
||||
|
||||
# Explain why this change is being made
|
||||
|
||||
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
|
||||
|
||||
# Provide links or keys to any relevant tickets, articles or other resources
|
||||
|
||||
# Use issues and merge requests' full URLs instead of short references,
|
||||
|
||||
# as they are displayed as plain text outside of GitLab
|
||||
|
||||
# --- COMMIT END ---
|
||||
|
||||
# --------------------
|
||||
|
||||
# Remember to
|
||||
|
||||
# Capitalize the subject line
|
||||
|
||||
# Use the imperative mood in the subject line
|
||||
|
||||
# Do not end the subject line with a period
|
||||
|
||||
# Subject must contain at least 3 words
|
||||
|
||||
# Separate subject from body with a blank line
|
||||
|
||||
# Commits that change 30 or more lines across at least 3 files should
|
||||
|
||||
# describe these changes in the commit body
|
||||
|
||||
# Do not use Emojis
|
||||
|
||||
# Use the body to explain what and why vs. how
|
||||
|
||||
# Can use multiple lines with "-" for bullet points in body
|
||||
|
||||
# For more information: https://chris.beams.io/posts/git-commit/
|
||||
|
||||
# --------------------
|
||||
```
|
||||
|
||||
### Template for commit messages
|
||||
|
||||
Below is a template commit message for your reference.
|
||||
|
||||
```md
|
||||
feat(components): [button] I did something with button
|
||||
|
||||
Blank between subject and body is expected.(period is expected)
|
||||
Describes your change in one line or multi-line.
|
||||
Capitalize your first letter when starting a new line
|
||||
Please do not exceeds 72 characters per line, because that would be harder to comprehend.
|
||||
|
||||
- You can also add bullet list symbol for better layout
|
||||
```
|
||||
|
||||
For the subject header, the format is:
|
||||
|
||||
```
|
||||
[type](scope): [messages]
|
||||
```
|
||||
|
||||
You can checkout the allowed values for **type** and **scope** in [commitlint.config.js](https://github.com/element-plus/element-plus/blob/c2ee36a7fc72b17742d43ecdff4e2912c416141d/commitlint.config.js#L57),
|
||||
|
||||
### Useful links
|
||||
|
||||
[Keeping git commit history clean](https://about.gitlab.com/blog/2018/06/07/keeping-git-commit-history-clean/)
|
||||
@ -1,41 +0,0 @@
|
||||
---
|
||||
title: Development FAQ
|
||||
lang: en-US
|
||||
---
|
||||
|
||||
# Development FAQ
|
||||
|
||||
Here are the problems that are easy to encounter in development.
|
||||
|
||||
## If you encounter dependency related issues
|
||||
|
||||
```shell
|
||||
rm -fr node_modules
|
||||
pnpm i
|
||||
```
|
||||
|
||||
## Link local dependencies
|
||||
|
||||
```shell
|
||||
# get dist
|
||||
pnpm build
|
||||
cd dist/element-plus
|
||||
# set cur element-plus to global `node_modules`
|
||||
pnpm link --global
|
||||
# for esm we also need link element-plus for dist
|
||||
pnpm link --global element-plus
|
||||
|
||||
# go to your project, link to `element-plus`
|
||||
cd your-project
|
||||
pnpm link --global element-plus
|
||||
```
|
||||
|
||||
> More info see [pnpm link](https://pnpm.io/cli/link).
|
||||
|
||||
## Theme
|
||||
|
||||
We should not write Chinese comments in scss files.
|
||||
|
||||
It will generate warning `@charset "UTF-8";` in the header of css file when built with vite.
|
||||
|
||||
> More info see [#3219](https://github.com/element-plus/element-plus/issues/3219).
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
title: Local Development
|
||||
lang: en-US
|
||||
---
|
||||
|
||||
# Local Development
|
||||
|
||||
## Bootstrap project
|
||||
|
||||
With command
|
||||
|
||||
```shell
|
||||
pnpm i
|
||||
```
|
||||
|
||||
the project will install all dependencies.
|
||||
|
||||
## Website preview
|
||||
|
||||
With command
|
||||
|
||||
```shell
|
||||
pnpm docs:dev
|
||||
```
|
||||
|
||||
the project will launch website for you to preview all existing component.
|
||||
|
||||
## Local development
|
||||
|
||||
See [Local development guide](https://github.com/element-plus/element-plus/blob/dev/CONTRIBUTING.md)
|
||||
|
||||
1. With command
|
||||
|
||||
```shell
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
will start the local development environment.
|
||||
|
||||
2. Add your component into `play/src/App.vue`
|
||||
|
||||
> App.vue
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<ComponentYouAreDeveloping />
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
// make sure this component is registered in @element-plus/components
|
||||
import { ComponentYouAreDeveloping } from '@element-plus/components'
|
||||
</script>
|
||||
```
|
||||
|
||||
Modify `App.vue` file per your needs to get things work.
|
||||
Loading…
Reference in New Issue
Block a user