Skip to content

Commit c38ebc5

Browse files
authored
fix(docs): add CONTRIBUTING.md and CODE_OF_CONDUCT.md (#342)
1 parent 79f7c40 commit c38ebc5

File tree

3 files changed

+129
-1
lines changed

3 files changed

+129
-1
lines changed

CODE_OF_CONDUCT.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
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 [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated 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 [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributions
2+
3+
🎉 Thanks for considering contributing to this project! 🎉
4+
5+
These guidelines will help you send a pull request.
6+
7+
If you're submitting an issue instead, please skip this document.
8+
9+
If your pull request is related to a typo or the documentation being unclear, please click on the relevant page's `Edit`
10+
button (pencil icon) and directly suggest a correction instead.
11+
12+
This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
13+
14+
Everyone is welcome regardless of personal background. We enforce a [Code of conduct](CODE_OF_CONDUCT.md) in order to
15+
promote a positive and inclusive environment.
16+
17+
## Development process
18+
19+
First fork and clone the repository. If you're not sure how to do this, please watch
20+
[these videos](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
21+
22+
Run:
23+
24+
```bash
25+
npm install
26+
```
27+
28+
Make sure everything is correctly setup with:
29+
30+
```bash
31+
npm test
32+
```
33+
34+
Before submitting a pull request make sure testing, linting and formatting are passing with:
35+
36+
```bash
37+
npm test
38+
npm run format
39+
npm run lint
40+
```
41+
42+
After submitting the pull request, please make sure the Continuous Integration checks are passing.
43+
44+
## Releasing
45+
46+
```bash
47+
npm version [major|minor|patch]
48+
```
49+
50+
Then:
51+
52+
```bash
53+
npm publish
54+
```

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"format:ci": "prettier --check 'lib/**/*.js' 'bin/**/*.js'",
1414
"test": "jest",
1515
"version": "auto-changelog -p --template keepachangelog && git add .",
16-
"prepublishOnly": "git push && git push --tags && gh-release"
16+
"prepublishOnly": "git push --follow-tags && gh-release"
1717
},
1818
"files": [
1919
"lib/*.js",

0 commit comments

Comments
 (0)