mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-02 22:30:04 +08:00
Update contributing guide (#3808)
This commit is contained in:
Wang Shidong
GitHub
parent
8be896786b
commit
67efff68d3
@ -7,45 +7,62 @@
|
||||
|
||||
## 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, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
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, gender identity
|
||||
and expression, level of experience, 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
|
||||
- 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
|
||||
- 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 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.
|
||||
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.
|
||||
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 SpaceVim@outlook.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior
|
||||
may be reported by contacting the project team at [support@spacevim.org](mailto:support@spacevim.org).
|
||||
The project team will review and investigate all complaints,
|
||||
and will respond in a way that it deems 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 [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
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.
|
||||
|
||||
@ -5,57 +5,26 @@
|
||||
|
||||
# Contributing to SpaceVim
|
||||
|
||||
SpaceVim is an volunteer effort; we encourage you to pitch in. The community makes SpaceVim what it is.
|
||||
SpaceVim is a project exist thanks to all the people who contribute,
|
||||
we are thankful for all the contributions from community.
|
||||
We have a few guidelines, which we ask all contributors to follow.
|
||||
|
||||
You need only consider reading the sections relevant to what you are going to do:
|
||||
Code contributions are welcome,
|
||||
Please read our [development guidelines](https://spacevim.org/development/)
|
||||
before your first contribution to get to know them.
|
||||
|
||||
- [Asking for help](#asking-for-help) if you are about to ask an usage 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 (PR).
|
||||
In any case, feel free to join us on the [gitter room](https://gitter.im/SpaceVim/SpaceVim)
|
||||
to ask questions about contributing.
|
||||
|
||||
### Asking for help
|
||||
## Pull Request
|
||||
|
||||
If you want to ask an usage question, be sure to look first into some places as it may hold the answers:
|
||||
- [FAQ](https://spacevim.org/faq/): Some of the most frequently asked questions are answered there.
|
||||
- [documentation](https://spacevim.org/documentation/): It is the general documentation of SpaceVim.
|
||||
- [gitter room](https://gitter.im/SpaceVim/SpaceVim): The official channel of SpaceVim.
|
||||
Submit your contribution against the `master` branch. You should not use your master branch
|
||||
to modify SpaceVim, this branch is considered to be read-only.
|
||||
|
||||
### Reporting issues
|
||||
|
||||
Issues have to be reported on [issues tracker](https://github.com/SpaceVim/SpaceVim/issues), Please:
|
||||
|
||||
- Search existing issues (including closed!)
|
||||
- Update SpaceVim to the latest version to see if your problem persists.
|
||||
- Use a clear title and follow the issue template.
|
||||
- Include step by step details on how to reproduce it.
|
||||
|
||||
### Contributing code
|
||||
|
||||
Code contributions are welcome. Please read the following sections carefully.
|
||||
In any case, feel free to join us on the [gitter room](https://gitter.im/SpaceVim/SpaceVim) to ask
|
||||
questions about contributing!
|
||||
|
||||
#### License
|
||||
## License
|
||||
|
||||
The license is GPLv3 for all the parts of SpaceVim. this includes:
|
||||
|
||||
- The initialization and core files.
|
||||
- All the layer files.
|
||||
- The documentation
|
||||
|
||||
For files not belonging to SpaceVim, such as 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.
|
||||
|
||||
#### Pull Request
|
||||
|
||||
Submit your contribution against the `master` branch. You should not use your master branch
|
||||
to modify SpaceVim, this branch is considered to be read-only.
|
||||
|
||||
You may want to read our [development guidelines](https://spacevim.org/development/).
|
||||
|
||||
|
||||
72
README.md
72
README.md
@ -17,36 +17,37 @@
|
||||
[](LICENSE)
|
||||
[](doc/SpaceVim.txt)
|
||||
|
||||
## About SpaceVim
|
||||
|
||||
|
||||
SpaceVim is a community-driven modular Vim distribution. It manages collections
|
||||
of plugins in layers, which help to collect related packages together to provide IDE-like features.
|
||||
SpaceVim is not just a vimrc but an ultimate Vim configuration, It contains many built-in features.
|
||||
|
||||
|
||||
|
||||
The last release is v1.5.0, check out [following-HEAD](https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD) page for what happened since last release.
|
||||
|
||||
## Instructions
|
||||
|
||||
**See the followings below for more information:**
|
||||
|
||||
- [Quick Start Guide](https://spacevim.org/quick-start-guide/)
|
||||
- [Documentation](https://spacevim.org/documentation/)
|
||||
- [Available Layers](https://spacevim.org/layers/)
|
||||
|
||||
If you have any questions about SpaceVim, please follow the [Getting Help Guide](https://github.com/SpaceVim/SpaceVim/wiki/Getting-help).
|
||||
**Table of context**
|
||||
|
||||
<!-- vim-markdown-toc GFM -->
|
||||
|
||||
- [New Features](#new-features)
|
||||
- [Project layout](#project-layout)
|
||||
- [Instructions](#instructions)
|
||||
- [Features](#features)
|
||||
- [Getting help](#getting-help)
|
||||
- [Contributing](#contributing)
|
||||
- [Project layout](#project-layout)
|
||||
- [Support SpaceVim](#support-spacevim)
|
||||
- [License](#license)
|
||||
- [Credits & Thanks](#credits--thanks)
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
|
||||
### New Features
|
||||
## Instructions
|
||||
|
||||
[SpaceVim](https://spacevim.org/) is a community-driven modular Vim distribution. It manages collections
|
||||
of plugins in layers, which help to collect related packages together to provide IDE-like features.
|
||||
|
||||
The last release is [v1.5.0](https://spacevim.org/SpaceVim-release-v1.5.0/), check out [following-HEAD](https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD) page for what happened since last release.
|
||||
|
||||
**See the followings below for more information:**
|
||||
|
||||
- [Quick Start Guide](https://spacevim.org/quick-start-guide/): a simple guide for Beginners.
|
||||
- [Documentation](https://spacevim.org/documentation/): The full documentation about using SpaceVim.
|
||||
- [Available Layers](https://spacevim.org/layers/): A list of all available layers included in SpaceVim.
|
||||
|
||||
### Features
|
||||
|
||||
This is a list of latest features implemented in SpaceVim:
|
||||
|
||||
@ -135,6 +136,19 @@ Create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asyn
|
||||
|
||||
For more features, please read [SpaceVim's Blog](https://spacevim.org/blog/)
|
||||
|
||||
|
||||
## Getting help
|
||||
|
||||
If you run into some problems installing, configuring, or using SpaceVim,
|
||||
checkout the [Getting help guidelines](https://github.com/SpaceVim/SpaceVim/wiki/Getting-help) in the wiki.
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
This project exists thanks to all the people who [contributed](CONTRIBUTING.md), We are thankful for any contributions from the community.
|
||||
|
||||
<a href="https://github.com/SpaceVim/SpaceVim/graphs/contributors"><img src="https://opencollective.com/spacevim/contributors.svg?width=890&button=false" /></a>
|
||||
|
||||
### Project layout
|
||||
|
||||
```txt
|
||||
@ -154,7 +168,7 @@ For more features, please read [SpaceVim's Blog](https://spacevim.org/blog/)
|
||||
└─ test/ tests
|
||||
```
|
||||
|
||||
### Support SpaceVim
|
||||
## Support SpaceVim
|
||||
|
||||
The best way to support SpaceVim is to contribute to it either by reporting bugs.
|
||||
Helping the community on the [Gitter Chat](https://gitter.im/SpaceVim/SpaceVim) or sending pull requests.
|
||||
@ -165,17 +179,15 @@ If you want to show your support financially you can buy a drink for the maintai
|
||||
|
||||
<a href='https://ko-fi.com/spacevim' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi4.png?v=f' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
|
||||
|
||||
| wechat | alipay |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| <a href='#support-spacevim'><img src="https://spacevim.org/img/weixin.png" height="150" width="150" /></a> | <a href='#support-spacevim'><img src="https://spacevim.org/img/zhifubao.png" height="150" width="150" /></a> |
|
||||
## License
|
||||
|
||||
Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv
|
||||
The license is GPLv3 for all the parts of SpaceVim. This includes:
|
||||
|
||||
### Credits & Thanks
|
||||
- The initialization and core files.
|
||||
- All the layer files.
|
||||
- The documentation
|
||||
|
||||
This project exists to thank all the people who have [contributed](CONTRIBUTING.md):
|
||||
|
||||
<a href="https://github.com/SpaceVim/SpaceVim/graphs/contributors"><img src="https://opencollective.com/spacevim/contributors.svg?width=890&button=false" /></a>
|
||||
## Credits & Thanks
|
||||
|
||||
- [@Gabirel](https://github.com/Gabirel) and his [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim)
|
||||
- [@everettjf](https://github.com/everettjf) and his [SpaceVimTutorial](https://everettjf.gitbooks.io/spacevimtutorial/content/)
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
Execute ( SpaceVim key binding guide ):
|
||||
let g:_spacevim_input_list = ['h', 'd', 'k', ' ', 'b', 'n']
|
||||
" let g:_spacevim_input_list = ['h', 'd', 'k', ' ', 'b', 'n']
|
||||
" LeaderGuide " "
|
||||
" AssertEqual &ft, 'HelpDescribe'
|
||||
|
||||
|
||||
@ -1,11 +1,13 @@
|
||||
welcome to <img src="https://spacevim.org/SpaceVim.png" height="17" width="17"> **SpaceVim** wiki, a Resources guideline for SpaceVim!
|
||||
welcome to <img src="https://spacevim.org/SpaceVim.png" height="17" width="17"> **SpaceVim** wiki,
|
||||
a resources guideline for SpaceVim!
|
||||
|
||||
|
||||
- [Home](https://spacevim.org): The official website of SpaceVim
|
||||
- [FAQ](https://spacevim.org/faq/): The most asked questions about SpaceVim
|
||||
- [Progress/Roadmap](https://spacevim.org/roadmap/): The roadmap and development progress of SpaceVim
|
||||
- [Blogs](https://spacevim.org/blog/): Latest news and posts about SpaceVim
|
||||
- [Home](https://spacevim.org): The official website of SpaceVim.
|
||||
- [FAQ](https://spacevim.org/faq/): The most asked questions about SpaceVim.
|
||||
- [Progress/Roadmap](https://spacevim.org/roadmap/): The roadmap and development progress of SpaceVim.
|
||||
- [Blogs](https://spacevim.org/blog/): Latest news and articles about SpaceVim
|
||||
- [Project layout](Project-layout): Layout of current project
|
||||
- [Support SpaceVim](support-spacevim)
|
||||
|
||||
### Users
|
||||
|
||||
@ -17,11 +19,10 @@ welcome to <img src="https://spacevim.org/SpaceVim.png" height="17" width="17">
|
||||
|
||||
### Developers
|
||||
|
||||
- [programming languages](programming-languages): a list of programming languages
|
||||
- [Development guidelines](https://spacevim.org/development/)
|
||||
- [Development tips](development-tips)
|
||||
|
||||
This wiki is generated from [`wiki/`](https://github.com/SpaceVim/SpaceVim/tree/master/wiki) directory
|
||||
automatically, if you want to contribute to the wiki, please send pull request to SpaceVim repo.
|
||||
|
||||
- [programming languages](programming-languages): a list of programming languages
|
||||
- [Development guidelines](https://spacevim.org/development/)
|
||||
- [CONTRIBUTING](https://github.com/SpaceVim/SpaceVim/blob/master/CONTRIBUTING.md)
|
||||
- [Support SpaceVim](support-spacevim)
|
||||
- [Development tips](development-tips)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user