Skip to content

Commit 9d1e632

Browse files
dmaccormackdmaccormack
committed
doc: add contributor guidance
1 parent 0e20191 commit 9d1e632

File tree

3 files changed

+181
-0
lines changed

3 files changed

+181
-0
lines changed

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Contributing to jsonurl-js
2+
======================
3+
So you found a bug or want to contribute a new feature? Great! Before
4+
you dig into the code there are some guidelines I need contributors to follow
5+
so that I have a reasonable chance of keeping things organized without too much
6+
effort.
7+
8+
Getting Started
9+
---------------
10+
+ Make sure you have a [GitHub account](https://github.com/signup/free).
11+
+ If you just want to make a small change see "Making Trivial Changes" below.
12+
+ If you're planning to implement a new feature it's a good idea to discuss
13+
it on [Zulip][zulip] first.
14+
This can help make sure you're not wasting your time on something that's
15+
considered out of scope.
16+
+ See if there is already an
17+
[issue](https://github.com/jsonurl/jsonurl-java/issues),
18+
or create a new one if necessary
19+
+ For defects, clearly describe the problem, including steps to reproduce
20+
+ For features, clearly describe the idea, including intent, audience, and
21+
use cases
22+
+ Fork the repository on GitHub.
23+
24+
Making and Submitting Changes
25+
--------------
26+
I accept pull requests via GitHub. [Zulip][zulip] is
27+
the main channel of communication for contributors.
28+
Here are some guidelines which will make applying PRs easier for me:
29+
+ Create a topic/feature branch from the `master` branch to base your work, and
30+
push your changes to a topic branch in your fork of the repository
31+
+ Make commits of logical units and with [meaningful][commit-message-howto],
32+
[semantic][semantic-commit-message] messages that reference the related
33+
GitHub issue
34+
+ Use the [style][eslintrc.js] of the existing codebase
35+
+ Make sure you have added/updated tests for your changes, and that all tests
36+
pass
37+
+ Submit a pull request once you're ready to merge
38+
39+
Making Trivial Changes
40+
----------------------
41+
For small changes, like tweaks to comments and/or documentation you don't need
42+
to create an issue. A fork + PR with a proper commit message (i.e. doc: ...)
43+
is sufficient.
44+
45+
[zulip]: https://jsonurl.zulipchat.com/#narrow/stream/248637-jsonurl-js
46+
[eslintrc.js]: .eslintrc.js
47+
[commit-message-howto]: https://chris.beams.io/posts/git-commit/
48+
[semantic-commit-message]: https://seesparkbox.com/foundry/semantic_commit_messages
49+

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
![CI](https://github.com/jsonurl/jsonurl-js/workflows/ci/badge.svg?branch=master)
55
[![Known Vulnerabilities](https://snyk.io/test/github/jsonurl/jsonurl-js/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jsonurl/jsonurl-js?targetFile=package.json)
66
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-js.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-js?ref=badge_shield)
7+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
8+
[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://jsonurl.zulipchat.com/)
79

810
## About
911
[RFC8259][RFC8259] describes the JSON data model and interchange format, which is widely

0 commit comments

Comments
 (0)