Skip to content

Commit 61c1bd5

Browse files
katheriskatheris
authored
fix: Update contributing guidelines
Signed-off-by: Katherine Stanley <[email protected]>
1 parent 0a9cb06 commit 61c1bd5

15 files changed

+234
-32
lines changed

‎CLA.md

-32
This file was deleted.

‎CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and 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 one of the project maintainers (@katheris or @GraceJansen). 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org

‎CONTRIBUTING.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Contributing to the Starter Vert.x Kafka app
2+
3+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
4+
5+
## Pull requests are always welcome
6+
7+
We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it.
8+
9+
To contribute code or documentation, please submit a [pull request](https://github.com/ibm-messaging/kafka-java-vertx-starter/pulls).
10+
11+
A good way to familiarize yourself with the codebase and contribution process is
12+
to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/ibm-messaging/kafka-java-vertx-starter/issues).
13+
14+
## Create issues...
15+
If you would like to implement a new feature, please [raise an issue](https://github.com/ibm-messaging/kafka-java-vertx-starter/issues)
16+
before sending a pull request so the feature can be discussed before you start working on it.
17+
18+
> Note: We appreciate your effort, and want to avoid a situation where a contribution
19+
requires extensive rework (by you or by us), sits in backlog for a long time, or
20+
cannot be accepted at all!
21+
22+
### ...but check for existing issues first!
23+
24+
Please take a moment to check that an issue doesn't already exist documenting your bug report or improvement proposal. If it does, it never hurts to add a quick "+1" or "I have this problem too". This will help prioritize the most common problems and requests.
25+
26+
### Merge approval
27+
28+
The project maintainers use LGTM (Looks Good To Me) in comments on the code
29+
review to indicate acceptance.
30+
31+
For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
32+
33+
## Legal
34+
35+
Each source file must include a license header for the Apache
36+
Software License 2.0. Using the SPDX format is the simplest approach.
37+
e.g.
38+
39+
```
40+
/*
41+
(C) Copyright <holder> <date>-<date> All Rights Reserved.
42+
43+
SPDX-License-Identifier: Apache-2.0
44+
*/
45+
```
46+
47+
We have tried to make it as easy as possible to make contributions. This
48+
applies to how we handle the legal aspects of contribution. We use the
49+
same approach - the [Developer's Certificate of Origin 1.1 (DCO)](https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt) - that the Linux® Kernel [community](https://elinux.org/Developer_Certificate_Of_Origin)
50+
uses to manage code contributions.
51+
52+
The rules are pretty simple: if you
53+
can certify the below (from [developercertificate.org](http://developercertificate.org/)):
54+
```
55+
Developer Certificate of Origin
56+
Version 1.1
57+
58+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
59+
660 York Street, Suite 102,
60+
San Francisco, CA 94110 USA
61+
62+
Everyone is permitted to copy and distribute verbatim copies of this
63+
license document, but changing it is not allowed.
64+
65+
66+
Developer's Certificate of Origin 1.1
67+
68+
By making a contribution to this project, I certify that:
69+
70+
(a) The contribution was created in whole or in part by me and I
71+
have the right to submit it under the open source license
72+
indicated in the file; or
73+
74+
(b) The contribution is based upon previous work that, to the best
75+
of my knowledge, is covered under an appropriate open source
76+
license and I have the right under that license to submit that
77+
work with modifications, whether created in whole or in part
78+
by me, under the same open source license (unless I am
79+
permitted to submit under a different license), as indicated
80+
in the file; or
81+
82+
(c) The contribution was provided directly to me by some other
83+
person who certified (a), (b) or (c) and I have not modified
84+
it.
85+
86+
(d) I understand and agree that this project and the contribution
87+
are public and that a record of the contribution (including all
88+
personal information I submit with it, including my sign-off) is
89+
maintained indefinitely and may be redistributed consistent with
90+
this project or the open source license(s) involved.
91+
```
92+
93+
then you just add a line to end of the git commit message:
94+
95+
```
96+
Signed-off-by: John Doe <[email protected]>
97+
```
98+
99+
using your real name. Sorry, no pseudonyms or anonymous contributions.
100+
101+
Many Git UI tools have support for adding the `Signed-off-by` line to the end of your commit
102+
message. This line can be automatically added by the `git commit` command by using the `-s` option.

‎MAINTAINERS.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# MAINTAINERS
2+
3+
Kate Stanley - [email protected]
4+
Grace Jansen - [email protected]

‎src/main/java/kafka/vertx/demo/Main.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo;
27

38
import io.vertx.core.CompositeFuture;

‎src/main/java/kafka/vertx/demo/consumer/ConsumerService.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.consumer;
27

38
import io.vertx.codegen.annotations.ProxyGen;

‎src/main/java/kafka/vertx/demo/consumer/ConsumerServiceImpl.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.consumer;
27

38
import io.vertx.core.AsyncResult;

‎src/main/java/kafka/vertx/demo/consumer/ConsumerVerticle.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.consumer;
27

38
import io.vertx.config.ConfigRetriever;

‎src/main/java/kafka/vertx/demo/consumer/DemoConsumedRecord.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.consumer;
27

38
public class DemoConsumedRecord {

‎src/main/java/kafka/vertx/demo/producer/PeriodicProducer.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.producer;
27

38
import io.vertx.core.AbstractVerticle;

‎src/main/java/kafka/vertx/demo/producer/ProducerService.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.producer;
27

38
import io.vertx.codegen.annotations.ProxyGen;

‎src/main/java/kafka/vertx/demo/producer/ProducerServiceImpl.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.producer;
27

38
import io.vertx.core.AsyncResult;

‎src/main/java/kafka/vertx/demo/producer/ProducerVerticle.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.producer;
27

38

‎src/main/java/kafka/vertx/demo/producer/RecordData.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.producer;
27

38
public class RecordData {

‎src/main/java/kafka/vertx/demo/websocket/WebsocketVerticle.java

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/*
2+
(C) Copyright IBM Corp. 2020 All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
16
package kafka.vertx.demo.websocket;
27

38
import io.vertx.core.AbstractVerticle;

0 commit comments

Comments
 (0)