UNPKG

4.8 kBMarkdownView Raw
1<!---
2 Copyright (c) 2018 Swashata Ghosh <swashata@wpquark.com>
3
4 This software is released under the MIT License.
5 https://opensource.org/licenses/MIT
6-->
7
8# Contributing
9
10When contributing to this repository, please first discuss the change you wish to make via issue,
11email, or any other method with the owners of this repository before making a change.
12
13Please note we have a code of conduct, please follow it in all your interactions with the project.
14
15## How to Setup
16
17The [README](README.md#development-environment) has a comprehensive guide on how to setup this project
18locally on your machine. A `TL;DR` version is
19
201. Install Nodejs >= 9 ( 8 may also work ).
212. Clone this repo.
223. Run `npm install` on the project folder. This will set things up.
234. Run `npm run serve` to see all examples and ui in the browser.
245. Edit files and make changes in `src` directory. Your browser will hot relaod.
256. Write down tests for new features.
26
27## Pull Request Process
28
291. Ensure any install or build dependencies are removed before the end of the layer when doing a
30 build.
312. Update the README.md with details of changes to the interface, this includes new
32 variables, APIs etc.
333. Increase the version numbers in any examples files and the README.md to the new version that this
34 Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
354. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
36 do not have permission to do that, you may request the second reviewer to merge it for you.
37
38## Code of Conduct
39
40### Our Pledge
41
42In the interest of fostering an open and welcoming environment, we as
43contributors and maintainers pledge to making participation in our project and
44our community a harassment-free experience for everyone, regardless of age, body
45size, disability, ethnicity, gender identity and expression, level of experience,
46nationality, personal appearance, race, religion, or sexual identity and
47orientation.
48
49### Our Standards
50
51Examples of behavior that contributes to creating a positive environment
52include:
53
54* Using welcoming and inclusive language
55* Being respectful of differing viewpoints and experiences
56* Gracefully accepting constructive criticism
57* Focusing on what is best for the community
58* Showing empathy towards other community members
59
60Examples of unacceptable behavior by participants include:
61
62* The use of sexualized language or imagery and unwelcome sexual attention or
63advances
64* Trolling, insulting/derogatory comments, and personal or political attacks
65* Public or private harassment
66* Publishing others' private information, such as a physical or electronic
67 address, without explicit permission
68* Other conduct which could reasonably be considered inappropriate in a
69 professional setting
70
71### Our Responsibilities
72
73Project maintainers are responsible for clarifying the standards of acceptable
74behavior and are expected to take appropriate and fair corrective action in
75response to any instances of unacceptable behavior.
76
77Project maintainers have the right and responsibility to remove, edit, or
78reject comments, commits, code, wiki edits, issues, and other contributions
79that are not aligned to this Code of Conduct, or to ban temporarily or
80permanently any contributor for other behaviors that they deem inappropriate,
81threatening, offensive, or harmful.
82
83### Scope
84
85This Code of Conduct applies both within project spaces and in public spaces
86when an individual is representing the project or its community. Examples of
87representing a project or community include using an official project e-mail
88address, posting via an official social media account, or acting as an appointed
89representative at an online or offline event. Representation of a project may be
90further defined and clarified by project maintainers.
91
92### Enforcement
93
94Instances of abusive, harassing, or otherwise unacceptable behavior may be
95reported by contacting the project team at [swashata4u at gmail dot com]. All
96complaints will be reviewed and investigated and will result in a response that
97is deemed necessary and appropriate to the circumstances. The project team is
98obligated to maintain confidentiality with regard to the reporter of an incident.
99Further details of specific enforcement policies may be posted separately.
100
101Project maintainers who do not follow or enforce the Code of Conduct in good
102faith may face temporary or permanent repercussions as determined by other
103members of the project's leadership.
104
105### Attribution
106
107This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
108available at [http://contributor-covenant.org/version/1/4][version]
109
110[homepage]: http://contributor-covenant.org
111[version]: http://contributor-covenant.org/version/1/4/