Skip to content
This repository was archived by the owner on Apr 22, 2024. It is now read-only.

Commit 9d65b1d

Browse files
committed
refactor: added missing standard documentation
1 parent 88f02a8 commit 9d65b1d

File tree

3 files changed

+237
-0
lines changed

3 files changed

+237
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
contributors@vuestorefront.io
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributing
2+
3+
Yeay! You want to contribute to @vuestorefront/redis-driver. That's amazing! To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.
4+
5+
6+
## Found an Issue?
7+
8+
Thank you for reporting any issues you find. We do our best to test and make @vuestorefront/redis-driver as solid as possible, but any reported issue is a real help.
9+
10+
Please follow these guidelines when reporting issues:
11+
12+
- Provide a title in the format of `<Error> when <Task>`
13+
- Tag your issue with the tag `bug`
14+
- Provide a short summary of what you are trying to do
15+
- Provide the log of the encountered error if applicable
16+
- Provide the exact version of @vuestorefront/redis-driver.
17+
- Be awesome and consider contributing a [pull request](#want-to-contribute)
18+
19+
## Want to contribute?
20+
21+
You consider contributing changes to @vuestorefront/redis-driver – we dig that!
22+
Please consider these guidelines when filing a pull request:
23+
24+
> @vuestorefront/redis-driver pull requests
25+
26+
- Follow the [Coding Rules](#coding-rules)
27+
- Follow the [Commit Rules](#commit-rules)
28+
- Make sure you rebased the current master branch when filing the pull request
29+
- Squash your commits when filing the pull request
30+
- Provide a short title with a maximum of 100 characters
31+
- Provide a more detailed description containing
32+
_ What you want to achieve
33+
_ What you changed
34+
_ What you added
35+
_ What you removed
36+
37+
## Coding Rules
38+
39+
To keep the code base of @vuestorefront/redis-driver neat and tidy the following rules apply to every change
40+
41+
> Coding standards
42+
43+
- `eslint` is king
44+
- Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
45+
- Be awesome
46+
47+
## Commit Rules
48+
49+
To help everyone with understanding the commit history of commitlint the following commit rules are enforced.
50+
To make your life easier @vuestorefront/redis-driver is commitizen-friendly and provides the npm run-script `commit`.
51+
52+
> Commit standards
53+
54+
- [conventional-changelog](https://github.com/conventional-changelog)
55+
- husky commit message hook available
56+
- present tense
57+
- maximum of 100 characters
58+
- message format of `$type($scope): $message`
59+
60+
## Definition of done
61+
Issue is considered complete when:
62+
1. The issue has precise requirements (acceptance criteria) - if issue description is not clear, please reach us out by adding the comment to the issue
63+
2. Those requirements are implemented in the code
64+
3. Code is covered by tests (at least unit or integration)
65+
4. Code is reviewed and approved by at least 1 person
66+
5. Code is deployed to the dev environment and tested by the developer
67+
6. Code is deployed to the stage as a part of a release. (we will be releasing a new version after each sprint) and tested by the Q.A. engineer
68+
1. tests including manual regression testing, usability, accessibility, and whether the business requirements are met
69+
7. Finally, the ticket is approved by the team leader/product owner and marked as done

SECURITY.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Security Policies and Procedures
2+
3+
This document outlines security procedures and general policies for the Vue Storefront Magento 2 Integraion.
4+
5+
* [Reporting a Bug](#reporting-a-bug)
6+
* [Disclosure Policy](#disclosure-policy)
7+
* [Comments on this Policy](#comments-on-this-policy)
8+
9+
## Reporting a Bug
10+
11+
The Vue Storefront Magento 2 Integraion team and community take all security bugs very seriously.
12+
Thank you for improving the security of our integration. We appreciate your efforts and
13+
responsible disclosure and will make every effort to acknowledge your contributions.
14+
15+
Report security bugs by emailing the lead maintainer at contributors@vuestorefront.io.
16+
17+
The lead maintainer will acknowledge your email within 48 hours, and will send a
18+
more detailed response within 48 hours indicating the next steps in handling
19+
your report. After the initial reply to your report, the security team will
20+
endeavor to keep you informed of the progress towards a fix and full
21+
announcement, and may ask for additional information or guidance.
22+
23+
Report security bugs in third-party modules to the person or team maintaining the module.
24+
25+
## Disclosure Policy
26+
27+
When the security team receives a security bug report, they will assign it to aprimary handler.
28+
This person will coordinate the fix and release process, involving the following steps:
29+
30+
* Confirm the problem and determine the affected versions.
31+
* Audit code to find any potential similar problems.
32+
* Prepare fixes for all releases still under maintenance. These fixes will be released as fast as possible to npm.
33+
34+
## Comments on this Policy
35+
36+
If you have suggestions on how this process could be improved please submit a pull request.

0 commit comments

Comments
 (0)