diff --git a/README.cn.md b/README.cn.md index a7ba09566..7b1fc36b1 100644 --- a/README.cn.md +++ b/README.cn.md @@ -12,7 +12,7 @@ [![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=master)](https://travis-ci.org/SpaceVim/SpaceVim) [![Build status](https://ci.appveyor.com/api/projects/status/eh3t5oph70abp665/branch/master?svg=true)](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/master) [![codecov](https://codecov.io/gh/SpaceVim/SpaceVim/branch/dev/graph/badge.svg)](https://codecov.io/gh/SpaceVim/SpaceVim/branch/master) -[![Version](https://img.shields.io/badge/version-1.6.0-8700FF.svg)](https://github.com/SpaceVim/SpaceVim/releases) +[![Version](https://img.shields.io/badge/version-1.7.0--dev-8700FF.svg)](https://github.com/SpaceVim/SpaceVim/releases) [![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE) ![welcome page](https://user-images.githubusercontent.com/13142418/103414298-5e1da980-4bb8-11eb-96bc-b2e118f672b5.png) diff --git a/README.md b/README.md index 2e5373327..39e9d6248 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ [![Build status](https://ci.appveyor.com/api/projects/status/eh3t5oph70abp665/branch/master?svg=true)](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/master) [![codecov](https://codecov.io/gh/SpaceVim/SpaceVim/branch/master/graph/badge.svg)](https://codecov.io/gh/SpaceVim/SpaceVim/branch/master) [![Docker Build Status](https://img.shields.io/docker/build/spacevim/spacevim.svg)](https://hub.docker.com/r/spacevim/spacevim/) -![Version](https://img.shields.io/badge/version-1.6.0-8700FF.svg) +![Version](https://img.shields.io/badge/version-1.7.0--dev-8700FF.svg) [![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](LICENSE) [![Doc](https://img.shields.io/badge/doc-%3Ah%20SpaceVim-orange.svg)](doc/SpaceVim.txt) diff --git a/autoload/SpaceVim.vim b/autoload/SpaceVim.vim index 814dd97fd..2c37a368c 100644 --- a/autoload/SpaceVim.vim +++ b/autoload/SpaceVim.vim @@ -43,7 +43,7 @@ scriptencoding utf-8 "" " Version of SpaceVim , this value can not be changed. -let g:spacevim_version = '1.6.0' +let g:spacevim_version = '1.7.0-dev' lockvar g:spacevim_version "" diff --git a/docs/cn/index.md b/docs/cn/index.md index 0cdbcd68b..5f67ed8a2 100644 --- a/docs/cn/index.md +++ b/docs/cn/index.md @@ -8,7 +8,7 @@ lang: zh [![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=master)](https://travis-ci.org/SpaceVim/SpaceVim) [![Build status](https://ci.appveyor.com/api/projects/status/eh3t5oph70abp665/branch/master?svg=true)](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/master) [![codecov](https://codecov.io/gh/SpaceVim/SpaceVim/branch/dev/graph/badge.svg)](https://codecov.io/gh/SpaceVim/SpaceVim/branch/master) -[![Version](https://img.shields.io/badge/version-1.6.0-8700FF.svg)](https://github.com/SpaceVim/SpaceVim/releases) +[![Version](https://img.shields.io/badge/version-1.7.0--dev-8700FF.svg)](https://github.com/SpaceVim/SpaceVim/releases) [![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE) ![welcome page](https://user-images.githubusercontent.com/13142418/103414298-5e1da980-4bb8-11eb-96bc-b2e118f672b5.png) diff --git a/docs/cn/install.cmd b/docs/cn/install.cmd index b22e0e1b1..690dac065 100644 --- a/docs/cn/install.cmd +++ b/docs/cn/install.cmd @@ -11,7 +11,7 @@ echo " \______/| ##____/ \_______/\_______/\_______/ \_/ |__|__/ |__/ echo " | ## " echo " | ## " echo " |__/ " -echo " 版本: 1.6.0 中文官网: https://spacevim.org/cn/ " +echo " 版本: 1.7.0-dev 中文官网: https://spacevim.org/cn/ " Push-Location ~ diff --git a/docs/cn/install.sh b/docs/cn/install.sh index 956d1e906..ee0bec614 100755 --- a/docs/cn/install.sh +++ b/docs/cn/install.sh @@ -84,7 +84,7 @@ On_IWhite='\033[0;107m' # White # }}} # version -Version='1.6.0' +Version='1.7.0-dev' #System name System="$(uname -s)" diff --git a/docs/development.md b/docs/development.md index a8ea5e2a1..64b93d9d9 100644 --- a/docs/development.md +++ b/docs/development.md @@ -11,8 +11,13 @@ description: "General contributing guidelines and changelog of SpaceVim, includi - [Reporting issues](#reporting-issues) - [Contributing code](#contributing-code) - [License](#license) - - [Bootstrap](#bootstrap) - [Conventions](#conventions) + - [Git commit style guide](#git-commit-style-guide) + - [types](#types) + - [scopes](#scopes) + - [subject](#subject) + - [body](#body) + - [footer](#footer) - [Pull Request](#pull-request) - [Title prefix of pull request](#title-prefix-of-pull-request) - [Rebase on top of upstream master](#rebase-on-top-of-upstream-master) @@ -58,7 +63,8 @@ Issues have to be reported on [issues tracker](https://github.com/SpaceVim/Space ## Contributing code -Code contributions are welcome. Please read the following sections carefully. In any case, feel free to join us on the [gitter chat](https://gitter.im/SpaceVim/SpaceVim) to ask questions about contributing! +Code contributions are welcome. Please read the following sections carefully. +In any case, feel free to join us on the [gitter chat](https://gitter.im/SpaceVim/SpaceVim) to ask questions about contributing! ### License @@ -68,17 +74,64 @@ The license is GPLv3 for all the parts of SpaceVim. This includes: - All the layer files. - The documentation -For files not belonging to SpaceVim like local packages and libraries, refer to the header file. Those files should not have an empty header, we may not accept code without a proper header file. - -### Bootstrap - -Before contributing to SpaceVim, you should know how does SpaceVim bootstrap, here is the logic of the bootstrap when SpaceVim startup. - - +For files not belonging to SpaceVim like local packages and libraries, +refer to the header file. Those files should not have an empty header, we may not accept code without a proper header file. ### Conventions -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. +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. + +``` +Type (scope): Subject + +body + +footer +``` + +#### types + +- `feat`: A new feature +- `fix`: A bug fix +- `docs`: Changes to documentation +- `style`: Formatting, missing semi colons, etc; no code change +- `refactor`: Refactoring production code +- `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, +should begin with a capital letter and do not end with a period. + +Use an imperative tone to describe what a commit does, +rather than what it did. For example, use change; not changed or changes. + +#### body + +Not all commits are complex enough to warrant a body 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 @@ -126,47 +179,11 @@ git rebase upstream/master #### For complex PRs -Squash only the commits with uninteresting changes like typos, syntax fixes, etc. And keep the important and isolated steps in different commits. +Squash only the commits with uninteresting changes like typos, syntax fixes, etc. +And keep the important and isolated steps in different commits. Those PRs are merged and explicitly not fast-forwarded. -Commit messages - -Write commit messages according to adapted [Tim Pope鈥檚 guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html): - -- Use present tense and write in the imperative: 鈥淔ix bug鈥, not 鈥渇ixed bug鈥 or 鈥渇ixes bug鈥. -- Start with a capitalized, short (72 characters or less) summary, followed by a blank line. -- If necessary, add one or more paragraphs with details, wrapped at 72 characters. -- Separate paragraphs by blank lines. - -This is a model commit message: - -```gitcommit -Capitalized, short (72 chars or less) summary - -More detailed explanatory text, if necessary. Wrap it to about 72 -characters or so. In some contexts, the first line is treated as the -subject of an email and the rest of the text as the body. The blank -line separating the summary from the body is critical (unless you omit -the body entirely); tools like rebase can get confused if you run the -two together. - -Write your commit message in the imperative: "Fix bug" and not "Fixed bug" -or "Fixes bug." This convention matches up with commit messages generated -by commands like git merge and git revert. - -Further paragraphs come after blank lines. - -- Bullet points are okay, too - - - Typically a hyphen or asterisk is used for the bullet, followed by a - single space, with blank lines in between, but conventions vary here - - - Use a hanging indent -``` - -[Gita] provide Vim mode for Git commit messages, which helps you to comply to these guidelines. - ### Contributing a layer Please read the layers documentation first. diff --git a/docs/index.md b/docs/index.md index 5ee5a16e9..047edf336 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,7 +7,7 @@ description: "SpaceVim is a community-driven vim distribution that seeks to prov [![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=master)](https://travis-ci.org/SpaceVim/SpaceVim) [![Build status](https://ci.appveyor.com/api/projects/status/eh3t5oph70abp665/branch/master?svg=true)](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/master) [![codecov](https://codecov.io/gh/SpaceVim/SpaceVim/branch/dev/graph/badge.svg)](https://codecov.io/gh/SpaceVim/SpaceVim/branch/master) -[![Version](https://img.shields.io/badge/version-1.6.0-8700FF.svg)](https://github.com/SpaceVim/SpaceVim/releases) +[![Version](https://img.shields.io/badge/version-1.7.0--dev-8700FF.svg)](https://github.com/SpaceVim/SpaceVim/releases) [![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE) ![welcome page](https://user-images.githubusercontent.com/13142418/103414298-5e1da980-4bb8-11eb-96bc-b2e118f672b5.png) diff --git a/docs/install.cmd b/docs/install.cmd index a48408bfb..919abf735 100644 --- a/docs/install.cmd +++ b/docs/install.cmd @@ -11,7 +11,7 @@ echo " \______/| ##____/ \_______/\_______/\_______/ \_/ |__|__/ |__/ echo " | ## " echo " | ## " echo " |__/ " -echo " version : 1.6.0 by : spacevim.org " +echo " version : 1.7.0-dev by : spacevim.org " Push-Location ~ diff --git a/docs/install.sh b/docs/install.sh index 6f019959a..cee958960 100755 --- a/docs/install.sh +++ b/docs/install.sh @@ -84,7 +84,7 @@ On_IWhite='\033[0;107m' # White # }}} # version -Version='1.6.0' +Version='1.7.0-dev' #System name System="$(uname -s)"