From 69c6809b34d5eb3387f13e9e959702ca8ec4c8ef Mon Sep 17 00:00:00 2001 From: zazzaz Date: Wed, 18 Nov 2020 22:41:22 +0800 Subject: [PATCH] chore: add some github config (#612) --- .github/CONTRIBUTING.en-US.md | 34 ++++++++++++++++++++++++++++++ .github/CONTRIBUTING.es.md | 36 ++++++++++++++++++++++++++++++++ .github/CONTRIBUTING.fr-FR.md | 34 ++++++++++++++++++++++++++++++ .github/CONTRIBUTING.zh-CN.md | 31 +++++++++++++++++++++++++++ .github/pull_request_template.md | 8 +++---- README.md | 2 +- 6 files changed, 140 insertions(+), 5 deletions(-) create mode 100644 .github/CONTRIBUTING.en-US.md create mode 100644 .github/CONTRIBUTING.es.md create mode 100644 .github/CONTRIBUTING.fr-FR.md create mode 100644 .github/CONTRIBUTING.zh-CN.md diff --git a/.github/CONTRIBUTING.en-US.md b/.github/CONTRIBUTING.en-US.md new file mode 100644 index 0000000000..0b97154cb0 --- /dev/null +++ b/.github/CONTRIBUTING.en-US.md @@ -0,0 +1,34 @@ +# Element Plus Contributing Guide + +Hi! Thank you for choosing Element Plus. + +Element Plus is a Vue 3.0 based component library for developers, designers and product managers. + +We are excited that you are interested in contributing to Element Plus. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines. + +## Issue Guidelines + +- Issues are exclusively for bug reports, feature requests and design-related topics. Other questions may be closed directly. If any questions come up when you are using Element Plus, please hit [Discord](https://discord.link/ElementPlus) for help. + +- Before submitting an issue, please check if similar problems have already been issued. + +- Please specify which version of `Element Plus` and `Vue` you are using, and provide OS and browser information. [JSFiddle](https://jsfiddle.net/) is recommended to build a live demo so that your issue can be reproduced clearly. + +## Pull Request Guidelines + +- Fork this repository to your own account. Do not create branches here. + +- Commit info should be formatted as `[Component Name]: Info about commit.` (e.g. `Button: Fix xxx bug`) + +- **DO NOT** include files inside `lib` directory. + +- Make sure that running `npm run build` outputs the correct files. + +- Rebase before creating a PR to keep commit history clear. + +- Make sure PRs are created to `dev` branch instead of `master` branch. + +- If your PR fixes a bug, please provide a description about the related bug. + +- Merging a PR takes two maintainers: one approves the changes after reviewing, and then the other reviews and merges. + diff --git a/.github/CONTRIBUTING.es.md b/.github/CONTRIBUTING.es.md new file mode 100644 index 0000000000..bbc857fd3d --- /dev/null +++ b/.github/CONTRIBUTING.es.md @@ -0,0 +1,36 @@ +# Guía para Contribuidores a `Element Plus` + +¡Hola! Gracias por elegir [Element Plus](http://element.eleme.io/#/en-US). + +`Element Plus` es un archivo de componentes para desarrolladores y para gerentes de productos ‘web’ basado en [Vue 3.0](https://vuejs.org/) + +Estamos orgullosos de que usted esta interesado en contribuir al proyecto `Element Plus`. Antes de someter sus contribuciones, por favor tome un momentito para leer estas simples guías para contribuidores. + + +## Guía Para Reportar Problemas (“Issues”) + +- Preguntas de otro tipo corren el riesgo de ser cerradas inmediatamente. Sí tiene preguntas sobre el uso de `Element`, vea [Discord](https://discord.link/ElementPlus) para más ayuda. + +- Antes de someter un informe sobre algún problema, sírvase de revisar sí ya hubo un informe. + +- Por favor especifique que versión de `Element Plus` y `Vue` que esta utilizando, y que versión de sistema operativo y que versión de navegador web que está utilizando. [JSFiddle](https://jsfiddle.net/) esta recomendado para crear un entorno para reproducir el problema claramente. + + +## Guías para un “Pull Request (PR)” + +- Crea una bifurcación (“fork”) del repositorio a su propia cuenta en github.com. Por favor no crea ramas nuevas aquí. + +- Cuando cometa su cambio, formatea en esta forma: `[Nombre de componente]: Datos sobre el “commit”.` (por ejemplo. `Button: Reparación de xxx error`) + +- **DE NINGUNA MANERA** incluya archivos dentro del directorio `lib`. + +- Asegúrese de que el comando `npm run build` produzca los archivos correctos. + +- “Rebase” antes de crear un “pull request (PR)” para mantener la historia de “commits” limpia. + +- Asegúrese que sus PRs se refrieran a la rama `dev` y no a la rama `master`. + +- Si su PR arregla un error técnico, por favor, haga referencia al error especifico. + +- Fusión de un PR requiere dos mantenedores: el primero aprueba los cambios después de revisar, y entonces el segundo mantenedor revisa los cambios y hace la fusión. + diff --git a/.github/CONTRIBUTING.fr-FR.md b/.github/CONTRIBUTING.fr-FR.md new file mode 100644 index 0000000000..739aa785e2 --- /dev/null +++ b/.github/CONTRIBUTING.fr-FR.md @@ -0,0 +1,34 @@ +# Guide à destination des contributeurs d'Element Plus + +Bonjour! Merci d'avoir choisi Element Plus. + +Element Plus est une bibliothèque de composants basée sur Vue 3.0 pour les développeurs, les designers et les chefs de produits. + +Nous sommes ravis que vous souhaitiez contribuer à Element Plus. Avant de soumettre votre contribution, veuillez vous assurer de prendre un moment pour lire les indications suivantes. + +## Concernant les issues + +- Les issues concernent exclusivement les bugs, les demandes de fonctionnalités et les sujets liés à la conception. Les questions concernant d'autres sujets peuvent être fermées directement. Si vous avez des questions à propos de l'utilisation d'Element Plus, veuillez vous rendre sur [Discord](https://discord.link/ElementPlus) pour obtenir de l'aide. + +- Avant de soumettre une issue, veuillez vérifier si des problèmes similaires n'ont pas déjà été signalés. + +- Veuillez spécifier la version de `Element Plus` et `Vue` que vous utilisez, et fournir des informations sur le système d'exploitation et le navigateur. [JSFiddle](https://jsfiddle.net/) est recommandé afin de construire une démo pour que votre problème puisse être reproduit clairement. + +## Concernant les pull requests + +- Faites un fork de ce dépôt vers votre compte. Ne créez pas de branches ici. + +- Les informations de validation doivent être formatées en tant que `[Nom du composant] : Info à propos de ce commit` (par exemple `Button : Fix xxx bug`) + +- **NE PAS** inclure de fichiers dans le répertoire `lib`. + +- Assurez-vous que l'exécution de `npm run build` génère les bons fichiers. + +- Faites un rebase avant la création d'une PR pour garder l'historique clair. + +- Assurez-vous que les PRs sont créés dans la branche `dev` au lieu de la branche `master`. + +- Si votre PR corrige un bug, veuillez fournir une description du bug en question. + +- La fusion d'un PR nécessite deux responsables: l'un approuve les modifications après révision, puis l'autre les révise et les fusionne. + diff --git a/.github/CONTRIBUTING.zh-CN.md b/.github/CONTRIBUTING.zh-CN.md new file mode 100644 index 0000000000..be70646cea --- /dev/null +++ b/.github/CONTRIBUTING.zh-CN.md @@ -0,0 +1,31 @@ +# Element Plus 贡献指南 + +Hi! 首先感谢你使用 Element Plus。 + +Element Plus 是一套为开发者、设计师和产品经理准备的开源组件库，旨在快速搭建页面。它基于 Vue 3.0 开发，并提供了配套的设计资源，充分满足可定制化的需求。 + +Element Plus 的成长离不开大家的支持，如果你愿意为 Element Plus 贡献代码或提供建议，请阅读以下内容。 + +## Issue 规范 +- issue 仅用于提交 Bug 或 Feature 以及设计相关的内容，其它内容可能会被直接关闭。如果你在使用时产生了疑问，请到 Slack 或 [Discord](https://discord.link/ElementPlus) 里咨询。 + +- 在提交 issue 之前，请搜索相关内容是否已被提出。 + +- 请说明 Element Plus 和 Vue 的版本号，并提供操作系统和浏览器信息。推荐使用 [JSFiddle](https://jsfiddle.net/) 生成在线 demo，这能够更直观地重现问题。 + +## Pull Request 规范 +- 请先 fork 一份到自己的项目下，不要直接在仓库下建分支。 + +- commit 信息要以`[组件名]: 描述信息` 的形式填写，例如 `Button: fix xxx bug`。 + +- **不要提交** `lib` 里面打包的文件。 + +- 执行 `npm run build` 后可以正确打包文件。 + +- 提交 PR 前请 rebase，确保 commit 记录的整洁。 + +- 确保 PR 是提交到 `dev` 分支，而不是 `master` 分支。 + +- 如果是修复 bug，请在 PR 中给出描述信息。 + +- 合并代码需要两名维护人员参与：一人进行 review 后 approve，另一人再次 review，通过后即可合并。 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4b3de08986..478042e670 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ - -- [ ] Component Migration +Please make sure these boxes are checked before submitting your PR, thank you! - -Fix # +* [ ] Make sure you follow Element's contributing guide ([中文](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.zh-CN.md) | [English](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.en-US.md) | [Español](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.es.md) | [Français](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.fr-FR.md)). +* [ ] Make sure you are merging your commits to `dev` branch. +* [ ] Add some descriptions and refer relative issues for you PR. diff --git a/README.md b/README.md index df4555a53a..1a6b8f22ed 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This project is still under heavy development. Feel free to join us and make you --- -Join our [Discord](https://discord.link/ElementPlus) to start communicating with everybody ![Discord](https://discord.com/api/guilds/746641026239954954/widget.png?style=shield) +Join our [Discord](https://discord.link/ElementPlus) to start communicating with everybody. ## Bootstrap project With command