Skip to content

Commit 4bf2d6a

Browse files
devCrossNetdevCrossNet
committed
chore: add community standards
1 parent 0ed3128 commit 4bf2d6a

File tree

6 files changed

+321
-0
lines changed

6 files changed

+321
-0
lines changed

‎.github/CONTRIBUTING.md

+199
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
# Contributing
2+
3+
We would love for you to contribute and help make it even better
4+
than it is today! As a contributor, here are the guidelines we would like you
5+
to follow:
6+
7+
- [Question or Problem?](#question)
8+
- [Issues and Bugs](#issue)
9+
- [Feature Requests](#feature)
10+
- [Submission Guidelines](#submit)
11+
- [Coding Rules](#rules)
12+
- [Commit Message Guidelines](#commit)
13+
14+
## <a name="question"></a> Got a Question or Problem?
15+
16+
Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests.
17+
18+
## <a name="issue"></a> Found an Issue?
19+
20+
If you find a bug in the source code or a mistake in the documentation, you can help us by
21+
[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
22+
[submit a Pull Request](#submit-pr) with a fix.
23+
24+
## <a name="feature"></a> Want a Feature?
25+
26+
You can _request_ a new feature by [submitting an issue](#submit-issue) to our [GitHub
27+
Repository][github]. If you would like to _implement_ a new feature, please submit an issue with
28+
a proposal for your work first, to be sure that we can use it.
29+
30+
First open an issue and outline your proposal so that it can be
31+
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
32+
and help you to craft the change so that it is successfully accepted into the project.
33+
34+
**All features require a proper design and review by team members and product owners.** Before starting work, you might want to
35+
discuss with us to figure out:
36+
37+
- Is this something we want?
38+
- What's the impact?
39+
40+
Answering those questions first in the request might help us make a decision.
41+
42+
## <a name="submit"></a> Submission Guidelines
43+
44+
### <a name="submit-issue"></a> Submitting an Issue
45+
46+
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you.
47+
48+
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. Having a reproducible
49+
scenario gives us wealth of important information without going back & forth to you with additional questions.
50+
51+
You can file new issues by filling out our [new issue form](https://github.com/vuesion/packages/issues/new).
52+
53+
### <a name="submit-pr"></a> Submitting a Pull Request (PR)
54+
55+
Before you submit your Pull Request (PR) consider the following guidelines:
56+
57+
- Search [GitHub](https://github.com/vuesion/packages/pulls) for an open or closed PR
58+
that relates to your submission. You don't want to duplicate effort.
59+
- Make your changes in a new git branch:
60+
61+
```shell
62+
git checkout -b my-fix-branch
63+
```
64+
65+
- Create your patch, **including appropriate test cases**.
66+
- Run the full test suite,
67+
and ensure that all tests pass.
68+
- Commit your changes using a descriptive commit message that follows our
69+
[commit message conventions](#commit). Adherence to these conventions
70+
is necessary because release notes are automatically generated from these messages.
71+
72+
```shell
73+
git commit -a
74+
```
75+
76+
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
77+
78+
- Push your branch to GitHub:
79+
80+
```shell
81+
git push origin my-fix-branch
82+
```
83+
84+
- In GitHub, send a pull request to `packages:master`.
85+
- If we suggest changes then:
86+
87+
- Make the required updates.
88+
- Re-run the test suites to ensure tests are still passing.
89+
- Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
90+
91+
```shell
92+
git rebase -i
93+
git push -f
94+
```
95+
96+
That's it! Thank you for your contribution!
97+
98+
#### After your pull request is merged
99+
100+
After your pull request is merged, you can safely delete your branch and pull the changes
101+
from the main (upstream) repository:
102+
103+
- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
104+
105+
```shell
106+
git push origin --delete my-fix-branch
107+
```
108+
109+
- Check out the master branch:
110+
111+
```shell
112+
git checkout master -f
113+
```
114+
115+
- Delete the local branch:
116+
117+
```shell
118+
git branch -D my-fix-branch
119+
```
120+
121+
- Update your master branch with the latest upstream version:
122+
123+
```shell
124+
git pull --ff upstream master
125+
```
126+
127+
## <a name="rules"></a> Coding Rules
128+
129+
To ensure consistency throughout the source code, keep these rules in mind as you are working:
130+
131+
- All features or bug fixes **must be tested** by one or more specs (unit-tests or e2e-tests).
132+
133+
## <a name="commit"></a> Commit Message Guidelines
134+
135+
We have very precise rules over how our git commit messages can be formatted. This leads to **more
136+
readable messages** that are easy to follow when looking through the **project history**. But also,
137+
we use the git commit messages to **generate the change log**.
138+
139+
### Commit Message Format
140+
141+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
142+
format that includes a **type**, a **scope** and a **subject**:
143+
144+
```
145+
<type>(<scope>): <subject>
146+
<BLANK LINE>
147+
<body>
148+
<BLANK LINE>
149+
<footer>
150+
```
151+
152+
The **header** is mandatory and the **scope** of the header is optional.
153+
154+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
155+
to read on GitHub as well as in various git tools.
156+
157+
### Revert
158+
159+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
160+
161+
### Type
162+
163+
Must be one of the following:
164+
165+
- **build**: Changes that affect the build system or external dependencies
166+
- **ci**: Changes to our CI configuration files and scripts
167+
- **docs**: Documentation only changes
168+
- **feat**: A new feature
169+
- **fix**: A bug fix
170+
- **perf**: A code change that improves performance
171+
- **refactor**: A code change that neither fixes a bug nor adds a feature
172+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
173+
semi-colons, etc)
174+
- **test**: Adding missing tests or correcting existing tests
175+
- **chore**: Maintenance
176+
177+
### Scope
178+
179+
The scope should be the name of the module affected as perceived by the person reading changelog generated from the commit messages.
180+
181+
### Subject
182+
183+
The subject contains succinct description of the change:
184+
185+
- use the imperative, present tense: "change" not "changed" nor "changes"
186+
- don't capitalize first letter
187+
- no dot (.) at the end
188+
189+
### Body
190+
191+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
192+
The body should include the motivation for the change and contrast this with previous behavior.
193+
194+
### Footer
195+
196+
The footer should contain any information about **Breaking Changes** and is also the place to
197+
reference GitHub issues that this commit **Closes**.
198+
199+
[github]: https://github.com/vuesion/packages/issues

‎.github/ISSUE_TEMPLATE/bug_report.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
**Describe the bug**
7+
A clear and concise description of what the bug is.
8+

‎.github/PULL_REQUEST_TEMPLATE.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
There are two main goals in this document, depending on the nature of your PR:
3+
4+
- description: please tell us about your PR
5+
- checklist: please review the checklist
6+
7+
To help to quickly understand the nature of your pull request,
8+
please create a description that incorporates the following elements:
9+
-->
10+
11+
### What is accomplished by your PR?
12+
13+
description...
14+
15+
### Is there something controversial in your PR?
16+
17+
please take a moment to tell us about your choices...
18+
19+
### Link to the Issue
20+
21+
or a link to a ticket system...
22+
23+
<!--
24+
Thanks for contributing!
25+
-->

‎CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. 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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Johannes Werner
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Vuesion Documentation
2+
3+
> Documentation of the [vuesion project](https://github.com/vuesion/vuesion)
4+
5+
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
6+
7+
# Contribute
8+
9+
Contributions are always welcome! Please read the [contribution guidelines](https://github.com/vuesion/packages/blob/master/.github/CONTRIBUTING.md) first.
10+
11+
# Development
12+
13+
- clone repo
14+
- run `npm install`
15+
16+
## Development
17+
18+
- run `npm run dev`
19+
20+
# License
21+
22+
[MIT](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)