Skip to content
This repository was archived by the owner on Jan 29, 2026. It is now read-only.

Commit 1e2bc9a

Browse files
committed
added contributing guidelines
1 parent 8726b49 commit 1e2bc9a

2 files changed

Lines changed: 90 additions & 0 deletions

File tree

CONTRIBUTING.md

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

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,7 @@ NOTE: **Windows** users should [enable symlinks](http://answers.perforce.com/art
106106
├── node_modules Node NPM packages
107107
└── plugins Project's plugins
108108
```
109+
110+
### Contributing
111+
112+
See [contributing.md](CONTRIBUTING.md) for contribution guidelines.

0 commit comments

Comments
 (0)