mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-02 22:50:06 +08:00
Update community & development page (#4373)
This commit is contained in:
Wang Shidong
GitHub
parent
c151563bc1
commit
a7e9465a8c
8
.github/ISSUE_TEMPLATE/feature_request.md
vendored
8
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -8,13 +8,13 @@ assignees: ''
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
<!-- A clear and concise description of what you want to happen. -->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
<!-- Add any other context or screenshots about the feature request here. -->
|
||||
|
||||
@ -20,9 +20,10 @@ lang: zh
|
||||
|
||||
### 资讯订阅
|
||||
|
||||
关注 SpaceVim 官方微博或微信公众号以获取最新资讯、新特性介绍、使用技巧等。
|
||||
最新的版本发布、新功能增加会通过 twitter 或者 Facebook 进行推送，欢迎订阅：
|
||||
|
||||
- <i class="fab fa-weibo"></i> [新浪微博](https://weibo.com/SpaceVim)
|
||||
- <i class="fab fa-twitter"></i> [twitter](https://twitter.com/SpaceVim)
|
||||
- <i class="fab fa-facebook"></i> [Facebook](https://www.facebook.com/SpaceVim)
|
||||
|
||||
### 问题反馈
|
||||
|
||||
@ -33,7 +34,7 @@ lang: zh
|
||||
|
||||
### 经验分享
|
||||
|
||||
之所以没有新建一个论坛，是因为每个用户都有自己喜欢和习惯了的社区，我们以 SpaceVim 标签汇总如下社区：
|
||||
如果你有想分享的东西，或者有想深入讨论的问题，请使用以下论坛：
|
||||
|
||||
- [知乎](https://www.zhihu.com/topic/20168681/newest)
|
||||
- [思否](https://segmentfault.com/t/spacevim)
|
||||
@ -72,4 +73,3 @@ spacevim-cn+unsubscribe@googlegroups.com
|
||||
- <i class="fab fa-rocketchat"></i> [`#spacevim-cn:matrix.org` Matrix 聊天室](https://app.element.io/#/room/#spacevim-cn:matrix.org)
|
||||
- <i class="fab fa-slack-hash"></i> [`#spacevim` slack 聊天室](https://spacevim.slack.com/messages/C88CTJ62J)
|
||||
- <i class="fab fa-discord"></i> [`#spacevim` discord 聊天室](https://discord.gg/g3MGdNB)
|
||||
- <i class="fab fa-whatsapp"></i> [`SpaceVim` WhatsApp 聊天室](https://chat.whatsapp.com/GQ40y0oiPhDHA9tMvDZteo)
|
||||
|
||||
@ -12,18 +12,23 @@ description: "A list of SpaceVim's public channels, All messages are bridged bet
|
||||
- [Feedback](#feedback)
|
||||
- [Mailing list](#mailing-list)
|
||||
- [Chat](#chat)
|
||||
- [Forum](#forum)
|
||||
- [Others](#others)
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
|
||||
### News
|
||||
|
||||
- [Follow @SpaceVim](https://twitter.com/SpaceVim)
|
||||
The news about spacevim will be post on twitter or facebook, feel free to follow them:
|
||||
|
||||
- <i class="fab fa-twitter"></i> [Twitter](https://twitter.com/SpaceVim)
|
||||
- <i class="fab fa-facebook"></i> [Facebook](https://www.facebook.com/SpaceVim)
|
||||
|
||||
### Feedback
|
||||
|
||||
Have you found a bug? Or maybe you want a new feature. Please use the
|
||||
[issue tracker](https://github.com/SpaceVim/SpaceVim/issues) to report any bugs or file feature requests.
|
||||
If you run into a bug or want a new feature.
|
||||
Please use the [issue tracker](https://github.com/SpaceVim/SpaceVim/issues)
|
||||
to report any bugs or file feature requests.
|
||||
|
||||
### Mailing list
|
||||
|
||||
@ -53,26 +58,27 @@ You can also view all the mail list history via google forum:
|
||||
|
||||
### Chat
|
||||
|
||||
All of these channels are bridged together. Click on one of the badges
|
||||
below to join the chat. In all of these channels, messages from
|
||||
`SpaceVimBot` are sent by a remote user, and the format of the remote
|
||||
messages is:
|
||||
|
||||
`**Nick:**` message
|
||||
All messages in these channels are bridged together.
|
||||
Messages from `SpaceVimBot` are sent by a remote user.
|
||||
Join on one of them to chat with us:
|
||||
|
||||
- <i class="fab fa-gitter"></i> [`SpaceVim/SpaceVim` on Gitter](https://gitter.im/SpaceVim/SpaceVim)
|
||||
- <i class="fas fa-comments"></i> [`#spacevim` on libera.chat](https://web.libera.chat/#spacevim)
|
||||
- <i class="fab fa-telegram-plane"></i> [`t.me/SpaceVim` on telegram](https://t.me/SpaceVim)
|
||||
- <i class="fas fa-comments"></i> [`#spacevim` on libera.chat](https://web.libera.chat/#spacevim)
|
||||
- <i class="fab fa-rocketchat"></i> [`#spacevim:matrix.org` on Matrix](https://app.element.io/#/room/#spacevim:matrix.org)
|
||||
- <i class="fab fa-slack-hash"></i> [`#spacevim` on slack](https://spacevim.slack.com/messages/C88CTJ62J)
|
||||
- <i class="fab fa-discord"></i> [`#spacevim` on discord](https://discord.gg/xcRQnF8)
|
||||
- <i class="fab fa-whatsapp"></i> [`SpaceVim` on WhatsApp](https://chat.whatsapp.com/E3HvOvKmFfHDDIq82Rfflx)
|
||||
|
||||
### Forum
|
||||
|
||||
If you have something you'd like to share, or a question you'd like to discuss in depth, use the following forums:
|
||||
|
||||
- [Reddit channel](https://reddit.com/r/spacevim)
|
||||
- [Facebook group](https://www.facebook.com/groups/spacevim)
|
||||
|
||||
|
||||
### Others
|
||||
|
||||
- <i class="fab fa-facebook"></i> [Facebook](https://www.facebook.com/SpaceVim)
|
||||
- <i class="fab fa-reddit"></i> [Reddit](https://reddit.com/r/spacevim)
|
||||
- <i class="fab fa-github"></i> [GitHub](https://github.com/SpaceVim/SpaceVim)
|
||||
- <i class="fab fa-youtube"></i> [YouTube](https://www.youtube.com/channel/UC-3q4dVFS7gBpxhrON1WxIA)
|
||||
- <i class="fab fa-product-hunt"></i> [Product Hunt](https://www.producthunt.com/posts/spacevim)
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Development"
|
||||
title: "Development"
|
||||
description: "General contributing guidelines and changelog of SpaceVim, including development information about SpaceVim"
|
||||
---
|
||||
|
||||
@ -8,7 +8,8 @@ description: "General contributing guidelines and changelog of SpaceVim, includi
|
||||
<!-- vim-markdown-toc GFM -->
|
||||
|
||||
- [Asking for help](#asking-for-help)
|
||||
- [Bug reporting](#bug-reporting)
|
||||
- [Reporting bugs](#reporting-bugs)
|
||||
- [Requesting new feature](#requesting-new-feature)
|
||||
- [Contributing code](#contributing-code)
|
||||
- [License](#license)
|
||||
- [Conventions](#conventions)
|
||||
@ -36,26 +37,31 @@ description: "General contributing guidelines and changelog of SpaceVim, includi
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
|
||||
SpaceVim is an effort of all the volunteers. We encourage you to pitch in. The community makes SpaceVim what it is.
|
||||
We have a few guidelines which we need all contributors to follow.
|
||||
SpaceVim is a joint effort of all contributors.
|
||||
We encourage you to participate in SpaceVim's development.
|
||||
This page describes the entire development process of SpaceVim.
|
||||
|
||||
You can only consider reading the sections relevant to what you are going to do:
|
||||
We have some guidelines that we need all contributors to follow.
|
||||
You can only think about reading the part that is relevant to what you are going to do:
|
||||
|
||||
- [Asking for help](#asking-for-help) if you are about to open an issue to ask a question.
|
||||
- [Reporting issues](#reporting-issues) if you are about to open a new issue.
|
||||
- [Contributing code](#contributing-code) if you are about to send a pull-request.
|
||||
- [Asking for help](#asking-for-help): if you are about to open an issue to ask a question.
|
||||
- [Requesting new feature](#requesting-new-feature): if you want a new feature.
|
||||
- [Reporting bugs](#reporting-bugs): if you run into a bug.
|
||||
- [Contributing code](#contributing-code): if you are about to send a pull-request.
|
||||
|
||||
## Asking for help
|
||||
|
||||
If you want to ask an usage question,
|
||||
be sure to look first into some places as it may hold the answers:
|
||||
If you have any questions about using SpaceVim,
|
||||
check out the following context first, which may contain the answers:
|
||||
|
||||
- <kbd>:h SpaceVim-faq</kbd>: Some of the most frequently asked questions are answered there.
|
||||
- `:h SpaceVim-faq`: Some of the most frequently asked questions are answered there.
|
||||
- [SpaceVim documentation](https://spacevim.org/documentation/): It is the general documentation of SpaceVim.
|
||||
|
||||
## Bug reporting
|
||||
Besides, you can also [chat with us](../community/#chat)
|
||||
|
||||
To report a bug, you can use the spacevim mailing list `spacevim@googlegroups.com`,
|
||||
## Reporting bugs
|
||||
|
||||
If you run into a bug, please follow these guidelines to get feedback.
|
||||
before sending mail, please:
|
||||
|
||||
- Check that no duplicate issue in [google groups](https://groups.google.com/forum/#!forum/spacevim)
|
||||
@ -64,6 +70,25 @@ before sending mail, please:
|
||||
- Use a clear title with `[bug]` prefix.
|
||||
- Include details on how to reproduce it, just like a step by step guide.
|
||||
|
||||
## Requesting new feature
|
||||
|
||||
If you want a new feature, use the [github issue tracker](https://github.com/SpaceVim/SpaceVim/issues) to file a new issue.
|
||||
You need to choose a concise title and refine the content in the issue template:
|
||||
|
||||
```
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||
|
||||
**Describe the solution you'd like**
|
||||
<!-- A clear and concise description of what you want to happen. -->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
**Additional context**
|
||||
<!-- Add any other context or screenshots about the feature request here. -->
|
||||
```
|
||||
|
||||
## Contributing code
|
||||
|
||||
Code contributions are welcome. Please read the following sections carefully.
|
||||
@ -86,7 +111,6 @@ SpaceVim is based on conventions, mainly for naming functions,
|
||||
keybindings definition and writing documentation.
|
||||
Please read the [conventions](https://spacevim.org/conventions/) before your first contribution to get to know them.
|
||||
|
||||
|
||||
### Git commit style guide
|
||||
|
||||
A git commit message consists a three distinct parts separated by black line.
|
||||
@ -109,14 +133,12 @@ footer
|
||||
- `test`: Adding tests, refactoring test; no production code change
|
||||
- `chore`: Updating build tasks, package manager configs, etc; no production code change
|
||||
|
||||
|
||||
#### scopes
|
||||
|
||||
- `layer`
|
||||
- `api`
|
||||
- `plugin`
|
||||
|
||||
|
||||
#### subject
|
||||
|
||||
Subjects should be no greater than 50 characters,
|
||||
@ -130,12 +152,10 @@ rather than what it did. For example, use change; not changed or changes.
|
||||
Not all commits are complex enough to warrant a body,
|
||||
therefore it is optional and only used when a commit requires a bit of explanation and context.
|
||||
|
||||
|
||||
#### footer
|
||||
|
||||
The footer is optional and is used to reference issue tracker IDs.
|
||||
|
||||
|
||||
### Pull Request
|
||||
|
||||
#### Title prefix of pull request
|
||||
@ -157,16 +177,19 @@ Here is an example:
|
||||
|
||||
- Fork SpaceVim repository
|
||||
- Clone your repository
|
||||
|
||||
```sh
|
||||
git clone ${YOUR_OWN_REPOSITORY_URL}
|
||||
```
|
||||
|
||||
- Add upstream remote
|
||||
|
||||
```sh
|
||||
git remote add upstream https://github.com/SpaceVim/SpaceVim.git
|
||||
```
|
||||
|
||||
- Fetch upstream and rebase on top of upstream master
|
||||
|
||||
```sh
|
||||
git fetch upstream
|
||||
git rebase upstream/master
|
||||
|
||||
Loading…
Reference in New Issue
Block a user