Skip to content

Commit 01960eb

Browse files
thincathinca
committed
Add github related files
1 parent b8ea021 commit 01960eb

11 files changed

+293
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at @thinca. All complaints will be
59+
reviewed and investigated and will result in a response that is deemed
60+
necessary and appropriate to the circumstances. The project team is obligated
61+
to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

‎.github/CONTRIBUTING.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing
2+
3+
Thank you for taking your time for this project!
4+
5+
First, see [Code of Conduct](./CODE_OF_CONDUCT.md).
6+
7+
8+
## Issues
9+
10+
There are some templates.
11+
Please choose a template and fill them.
12+
13+
When you can not find an appropriate template, you do not have to use it.
14+
15+
16+
### About `question`
17+
18+
Please check [past `question` issues](../../../issues?q=label%3Aquestion) before you ask.
19+
20+
21+
## Pull Requests
22+
23+
There are some templates.
24+
Please choose a template and fill them.
25+
26+
Please consider opening a issue before opening a PR when your proposal is big.
27+
28+
29+
### About Git Repository
30+
31+
#### Branches
32+
33+
There are two important branches.
34+
35+
- `develop` branch
36+
- A branch for development.
37+
- This branch may not exist.
38+
- Please send a Pull Request to this if this exists.
39+
- Exclude some of the urgent ones.
40+
- `master` branch
41+
- A branch for release.
42+
43+
44+
#### Commits
45+
46+
Keep clean. When you pushed dirty commits, please organize before merge.
47+
48+
49+
#### Force Push
50+
51+
You can use force pushing freely. GitHub shows a link to see the difference between before force pushing and after force pushing.
52+
53+
54+
## About Neovim
55+
56+
My plugin does not support Neovim. And, there are no plans to include codes for supporting Neovim.
57+
Because I do not use Neovim, so I can not keep the codes working on Neovim.
58+
Sorry.

‎.github/ISSUE_TEMPLATE/bug_report.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
<!-- Please describe all sections -->
10+
11+
### Describe the bug
12+
<!-- A clear and concise description of what the bug is. -->
13+
14+
### Provide a minimal vimrc with less than 50 lines to reproduce
15+
<!-- Paste a minimal vimrc below to reproduce problem. -->
16+
17+
```vim
18+
```
19+
20+
### How to reproduce the problem from Vim startup
21+
<!-- Steps to reproduce the behavior. -->
22+
23+
### Expected behavior
24+
<!-- A clear and concise description of what you expected to happen. -->
25+
26+
### Actual behavior
27+
<!-- A clear and concise description of what actual happened. -->
28+
29+
### Screenshots (If possible)
30+
31+
32+
### Your environment
33+
34+
- OS:
35+
- Vim's version:
36+
- Plugin's version:
37+
38+
### Additional context (If any)
39+

‎.github/ISSUE_TEMPLATE/feature_request.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
<!-- Please describe all sections -->
10+
11+
### Is your feature request related to a problem?
12+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
13+
14+
### Describe the solution you'd like
15+
<!-- A clear and concise description of what you want to happen. -->
16+
17+
### Additional context
18+
<!-- Add any other context or screenshots about the feature request here. -->
19+

‎.github/ISSUE_TEMPLATE/question.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Question
3+
about: Any questions about usage, features, or others
4+
title: ''
5+
labels: 'question'
6+
assignees: ''
7+
---
8+
9+
<!-- A clear and concise description of your question. -->
10+

‎.github/PULL_REQUEST_TEMPLATE.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
You can choose Pull Request template. (Select `Preview` tab first)
2+
3+
- [Issue resolving](?template=issue_resolving.md&expand=1)
4+
- Resolve an existing issue
5+
- [Bug fix](?template=bug_fix.md&labels=bug&expand=1)
6+
- Fix a bug
7+
- [Trivial fix](?template=trivial_fix.md&labels=trivial&expand=1)
8+
- A small improvement fixing a typo, coding style, default configuration, and so on
9+
- [New feature](?template=new_feature.md&labels=enhancement&expand=1)
10+
- Propose a new feature to improve the project
11+
12+
Or, remove all text and describe about your Pull Request!
13+
14+
(Note that DO NOT USE this(you look) template. This is a navigation page.)

‎.github/PULL_REQUEST_TEMPLATE/bug_fix.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
If you fixing a bug already reported, use "Issue resolving" template instead.
3+
-->
4+
5+
<!-- Please describe all sections -->
6+
7+
### Describe the bug
8+
<!-- A clear and concise description of what the bug is. -->
9+
10+
### Provide a minimal vimrc with less than 50 lines to reproduce
11+
<!-- Paste a minimal vimrc below to reproduce problem. -->
12+
13+
```vim
14+
```
15+
16+
### How to reproduce the problem from Vim startup
17+
<!-- Steps to reproduce the behavior. -->
18+
19+
### Expected behavior
20+
<!-- A clear and concise description of what you expected to happen. -->
21+
22+
### Actual behavior
23+
<!-- A clear and concise description of what actual happened. -->
24+
25+
### Screenshots (If possible)
26+
27+
28+
### Your environment
29+
30+
- OS:
31+
- Vim's version:
32+
- Plugin's version:
33+
34+
### Additional context (If any)
35+

‎.github/PULL_REQUEST_TEMPLATE/issue_resolving.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<!-- Fill the issue number. -->
2+
This pull request closes #xxx
3+
4+
### How to resolve
5+
<!-- Describe the solution for the issue. -->
6+

‎.github/PULL_REQUEST_TEMPLATE/new_feature.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Please describe all sections -->
2+
3+
### Is your suggesting new feature related to a problem?
4+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
5+
6+
### Describe the solution you'd like
7+
<!-- A clear and concise description of what you want to happen. -->
8+
9+
### Additional context
10+
<!-- Add any other context or screenshots about the new feature here. -->
11+

‎.github/PULL_REQUEST_TEMPLATE/trivial_fix.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<!--
2+
Many descriptions may not be necessary.
3+
Add some descriptions if you think need.
4+
Empty is OK.
5+
-->
6+

‎LICENSE.txt

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
zlib License
2+
3+
(C) 2014 thinca <[email protected]>
4+
5+
This software is provided 'as-is', without any express or implied
6+
warranty. In no event will the authors be held liable for any damages
7+
arising from the use of this software.
8+
9+
Permission is granted to anyone to use this software for any purpose,
10+
including commercial applications, and to alter it and redistribute it
11+
freely, subject to the following restrictions:
12+
13+
1. The origin of this software must not be misrepresented; you must not
14+
claim that you wrote the original software. If you use this software
15+
in a product, an acknowledgment in the product documentation would be
16+
appreciated but is not required.
17+
2. Altered source versions must be plainly marked as such, and must not be
18+
misrepresented as being the original software.
19+
3. This notice may not be removed or altered from any source distribution.

0 commit comments

Comments
 (0)