forked from ant-design-blazor/ant-design-blazor
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add guides (ant-design-blazor#414)
- Loading branch information
1 parent
9fa815e
commit e72ac21
Showing
11 changed files
with
761 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Contributing to Ant Design | ||
|
||
Want to contribute to Ant Design? There are a few things you need to know. | ||
|
||
We wrote a **[contribution guide](https://ant.design/en-US/docs/contributing)** to help you get started. | ||
|
||
--- | ||
|
||
# 参与共建 | ||
|
||
想要给 Ant Design Blazor 贡献自己的一份力量? | ||
|
||
我们写了一份 **[贡献指南](https://ant.design/zh-CN/docs/contributing)** 来帮助你开始。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
name: 🐞 Bug report | ||
about: Create a report about something that is not working | ||
--- | ||
|
||
|
||
### Describe the bug | ||
A clear and concise description of what the bug is. | ||
|
||
### To Reproduce | ||
<!-- | ||
We ❤ code! Point us to a minimalistic repro project hosted in a GitHub repo. | ||
For a repro project, create a new ASP.NET Core project using the template of your your choice, apply the minimum required code to result in the issue you're observing. | ||
We will close this issue if: | ||
- the repro project you share with us is complex. We can't investigate custom projects, so don't point us to such, please. | ||
- if we will not be able to repro the behavior you're reporting | ||
--> | ||
|
||
### Exceptions (if any) | ||
<!-- | ||
Include the exception you get when facing this issue | ||
--> | ||
|
||
### Further technical details | ||
- AntDesign Nuget Package version | ||
- Include the output of `dotnet --info` | ||
- The IDE (VS / VS Code/ VS4Mac) you're running on, and it's version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: 💡 Feature request | ||
about: Suggest an idea for this project | ||
--- | ||
|
||
### Is your feature request related to a problem? Please describe. | ||
A clear and concise description of what the problem is. | ||
Example: I am trying to do [...] but [...] | ||
|
||
### Describe the solution you'd like | ||
A clear and concise description of what you want to happen. Include any alternative solutions you've considered. | ||
|
||
### Additional context | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<!-- | ||
First of all, thank you for your contribution! 😄 | ||
New feature please send pull request to feature branch, and rest to master branch. | ||
Pull request will be merged after one of collaborators approve. | ||
Please makes sure that these form are filled before submitting your pull request, thank you! | ||
--> | ||
|
||
[[中文版模板 / Chinese template](https://github.com/ant-design-blazor/ant-design-blazor/blob/master/.github/PULL_REQUEST_TEMPLATE/pr_cn.md)] | ||
|
||
### 🤔 This is a ... | ||
|
||
- [ ] New feature | ||
- [ ] Bug fix | ||
- [ ] Site / documentation update | ||
- [ ] Demo update | ||
- [ ] Component style update | ||
- [ ] TypeScript definition update | ||
- [ ] Bundle size optimization | ||
- [ ] Performance optimization | ||
- [ ] Refactoring | ||
- [ ] Code style optimization | ||
- [ ] Test Case | ||
- [ ] Branch merge | ||
- [ ] Other (about what?) | ||
|
||
### 🔗 Related issue link | ||
|
||
<!-- | ||
1. Describe the source of requirement, like related issue link. | ||
--> | ||
|
||
### 💡 Background and solution | ||
|
||
<!-- | ||
1. Describe the problem and the scenario. | ||
2. GIF or snapshot should be provided if includes UI/interactive modification. | ||
3. How to fix the problem, and list final API implementation and usage sample if that is an new feature. | ||
--> | ||
|
||
### 📝 Changelog | ||
|
||
<!-- | ||
Describe changes from userside, and list all potential break changes or other risks. | ||
---> | ||
|
||
| Language | Changelog | | ||
| ---------- | --------- | | ||
| 🇺🇸 English | | | ||
| 🇨🇳 Chinese | | | ||
|
||
### ☑️ Self Check before Merge | ||
|
||
⚠️ Please check all items below before review. ⚠️ | ||
|
||
- [ ] Doc is updated/provided or not needed | ||
- [ ] Demo is updated/provided or not needed | ||
- [ ] Changelog is provided or not needed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<!-- | ||
首先,感谢你的贡献!😄 | ||
新特性请提交至 feature 分支,其余可提交至 master 分支。 | ||
在一个维护者审核通过后合并。 | ||
请确保填写以下 pull request 的信息,谢谢!~ | ||
[[English Template / 英文模板](?expand=1)] | ||
--> | ||
|
||
### 🤔 这个变动的性质是? | ||
|
||
- [ ] 新特性提交 | ||
- [ ] 日常 bug 修复 | ||
- [ ] 站点、文档改进 | ||
- [ ] 演示代码改进 | ||
- [ ] 组件样式改进 | ||
- [ ] TypeScript 定义更新 | ||
- [ ] 包体积优化 | ||
- [ ] 性能优化 | ||
- [ ] 重构 | ||
- [ ] 代码风格优化 | ||
- [ ] 测试用例 | ||
- [ ] 分支合并 | ||
- [ ] 其他改动(是关于什么的改动?) | ||
|
||
### 🔗 相关 Issue | ||
|
||
<!-- | ||
1. 描述相关需求的来源,如相关的 issue 讨论链接。 | ||
--> | ||
|
||
### 💡 需求背景和解决方案 | ||
|
||
<!-- | ||
1. 要解决的具体问题。 | ||
2. 列出最终的 API 实现和用法。 | ||
3. 涉及UI/交互变动需要有截图或 GIF。 | ||
--> | ||
|
||
### 📝 更新日志怎么写? | ||
|
||
<!-- | ||
> 从用户角度描述具体变化,以及可能的 breaking change 和其他风险? | ||
--> | ||
|
||
| 语言 | 更新描述 | | ||
| ------- | -------- | | ||
| 🇺🇸 英文 | | | ||
| 🇨🇳 中文 | | | ||
|
||
### ☑️ 请求合并前的自查清单 | ||
|
||
⚠️ 请自检并全部**勾选全部选项**。⚠️ | ||
|
||
- [ ] 文档已补充或无须补充 | ||
- [ ] 代码演示已提供或无须提供 | ||
- [ ] Changelog 已提供或无须提供 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
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, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Scope | ||
|
||
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. | ||
|
||
## Enforcement | ||
|
||
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. | ||
|
||
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. | ||
|
||
## Attribution | ||
|
||
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 | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
Oops, something went wrong.