Skip to content

Commit 84f6365

Browse files
committed
added contributing; added coc; updated readme
Signed-off-by: Gavin Johnson <[email protected]>
1 parent 0b98b40 commit 84f6365

File tree

3 files changed

+230
-3
lines changed

3 files changed

+230
-3
lines changed

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Contributing
2+
3+
Thanks for choosing to contribute!
4+
5+
The following are a set of guidelines to follow when contributing to this project.
6+
7+
8+
## Code Of Conduct
9+
10+
This project adheres to the rtdl [code of conduct](./CODE_OF_CONDUCT.md) - a
11+
direct adaptation of the [Contributor Covenant](https://www.contributor-covenant.org/),
12+
version [2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
13+
By participating, you are expected to uphold this code. Please report
14+
unacceptable behavior to [[email protected]](mailto:[email protected]).
15+
16+
17+
## Have A Question?
18+
19+
Start by filing an issue. The existing committers on this project work to reach
20+
consensus around project direction and issue solutions within issue threads
21+
(when appropriate).
22+
23+
24+
## Developer Certificate of Origin
25+
26+
rtdl is an open source product released under the MIT license
27+
(see the [LICENSE file](./LICENSE)). The MIT license allows you to
28+
freely use, modify, distribute, and sell your own products that include
29+
MIT licensed software.
30+
31+
We respect intellectual property rights of others and we want to make
32+
sure all incoming contributions are correctly attributed and licensed.
33+
A Developer Certificate of Origin (DCO) is a lightweight mechanism to
34+
do that.
35+
36+
The DCO is a declaration attached to every contribution made by every
37+
developer. In the commit message of the contribution, the developer
38+
simply adds a `Signed-off-by` statement and thereby agrees to the DCO,
39+
which you can find below or at [developercertificate.org](http://developercertificate.org/).
40+
41+
```
42+
Developer's Certificate of Origin 1.1
43+
44+
By making a contribution to this project, I certify that:
45+
46+
(a) The contribution was created in whole or in part by me and I
47+
have the right to submit it under the open source license
48+
indicated in the file; or
49+
50+
(b) The contribution is based upon previous work that, to the best
51+
of my knowledge, is covered under an appropriate open source
52+
license and I have the right under that license to submit that
53+
work with modifications, whether created in whole or in part
54+
by me, under the same open source license (unless I am
55+
permitted to submit under a different license), as indicated
56+
in the file; or
57+
58+
(c) The contribution was provided directly to me by some other
59+
person who certified (a), (b) or (c) and I have not modified
60+
it.
61+
62+
(d) I understand and agree that this project and the contribution
63+
are public and that a record of the contribution (including all
64+
personal information I submit with it, including my sign-off) is
65+
maintained indefinitely and may be redistributed consistent with
66+
this project or the open source license(s) involved.
67+
68+
```
69+
We require that every contribution to rtdl is signed with a DCO.
70+
Additionally, please use your real name. We do not accept anonymous
71+
contributors nor those utilizing pseudonyms.
72+
73+
Each commit must include a DCO which looks like this
74+
75+
```
76+
Signed-off-by: Jane Smith <[email protected]>
77+
```
78+
You may type this line on your own when writing your commit messages.
79+
However, if your user.name and user.email are set in your git configs,
80+
you can use `-s` or `--signoff` to add the `Signed-off-by` line to the
81+
end of the commit message.
82+
83+
84+
## Code Reviews
85+
86+
All submissions should come in the form of pull requests and need to be reviewed
87+
by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/)
88+
for more information on sending pull requests.
89+

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@ Containerized PostgreSQL client for executing SQL commands in containerized envi
33

44
The `psql-client` image is stored on Docker Hub in the [rtdl/psql-client repository](https://hub.docker.com/r/rtdl/psql-client).
55

6-
## Use
6+
## rtdl - The Real-Time Data Lake
7+
This is a sub-project of [rtdl](https://github.com/realtimedatalake/rtdl) – the real-time
8+
data lake. Please go to rtdl's repo and give it a star.
9+
10+
## How to use
711
This image is not interactive and has no default ENTRYPOINT. You can use the `entrypoint` option to execute psql commands and `volumes` to load scripts that can be executed with the psql client.
8-
**Docker Run example**
12+
### Docker Run example
913
```
1014
docker run --name psql-client \
1115
-v ${PWD}/catalog/scripts/create-user-db.postgres.sql:/create-user-db.postgres.sql \
@@ -14,7 +18,7 @@ rtdl/psql-client:latest \
1418
-h dbhost -p 5433 -U postgres -f /create-user-db.postgres.sql
1519
```
1620

17-
**Docker Compose example**
21+
### Docker Compose example
1822
```
1923
psql-client:
2024
image: rtdl/psql-client:latest

0 commit comments

Comments
 (0)