From 1258f163c7a66be2266ba37d763b6aa2c4d8043f Mon Sep 17 00:00:00 2001 From: wsdjeg Date: Sat, 22 Oct 2022 09:30:04 +0800 Subject: [PATCH] docs(community): update development and community page --- docs/community.md | 25 ++++++++++++++++++++++--- docs/development.md | 42 +++++++----------------------------------- 2 files changed, 29 insertions(+), 38 deletions(-) diff --git a/docs/community.md b/docs/community.md index 665436133..9893a4fbf 100644 --- a/docs/community.md +++ b/docs/community.md @@ -8,7 +8,9 @@ description: "A list of SpaceVim's public channels, All messages are bridged bet - [News](#news) -- [Feedback](#feedback) +- [Asking for help](#asking-for-help) +- [Reporting bugs](#reporting-bugs) +- [Requesting new feature](#requesting-new-feature) - [Chat](#chat) - [Others](#others) @@ -20,9 +22,26 @@ The news about spacevim will be post on twitter, feel free to follow them: - [Twitter](https://twitter.com/SpaceVim) -## Feedback +## Asking for help + +If you have any questions about using SpaceVim, +check out the following context first, which may contain the answers: + +- [FAQ](../faq/): Some of the most frequently asked questions are answered there. +- [Documentation](../documentation/): It is the general documentation of SpaceVim. + +## Reporting bugs + +If you run into a bug, please follow the guidelines below to give feedback. + +- Update the SpaceVim to the latest version. And make sure the can be reproduced in latest version of spacevim. +- [Open new issue on github](https://github.com/SpaceVim/SpaceVim/issues/new?assignees=&labels=&template=bug_report.md&title=), and follow the `bug reporting` template. + +## Requesting new feature + +If you want a new feature or have an idea to improve spacevim, +feel free to [open new issue](https://github.com/SpaceVim/SpaceVim/issues/new?assignees=&labels=feature+request&template=feature_request.md&title=) for feature requesting. -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. ## Chat diff --git a/docs/development.md b/docs/development.md index 213bf62c5..ce8ac76d1 100644 --- a/docs/development.md +++ b/docs/development.md @@ -5,11 +5,15 @@ description: "General contributing guidelines and changelog of SpaceVim, includi # Development +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. + +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) -- [Reporting bugs](#reporting-bugs) -- [Requesting new feature](#requesting-new-feature) - [Contributing code](#contributing-code) - [License](#license) - [Conventions](#conventions) @@ -32,38 +36,6 @@ description: "General contributing guidelines and changelog of SpaceVim, includi -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. - -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. -- [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 have any questions about using SpaceVim, -check out the following context first, which may contain the answers: - -- `: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. - -Besides, you can also [chat with us](../community/#chat) - -## Reporting bugs - -If you run into a bug, please follow the guidelines below to give feedback. - -- Update the SpaceVim to the latest version. And make sure the can be reproduced in latest version of spacevim. -- [Open new issue on github](https://github.com/SpaceVim/SpaceVim/issues/new?assignees=&labels=&template=bug_report.md&title=), and follow the `bug reporting` template. - -## Requesting new feature - -If you want a new feature or have an idea to improve spacevim, feel free to [open new issue](https://github.com/SpaceVim/SpaceVim/issues/new?assignees=&labels=feature+request&template=feature_request.md&title=) for feature requesting. ## Contributing code