Skip to content

Commit 08c22da

Browse files
msmygitmsmygit
authored
Merge pull request #72 from datastax/recognize-contributors
Move contributors to CONTRIBUTING.md file. Create an initial version of code of conduct
2 parents 4edef5d + f8145fd commit 08c22da

File tree

4 files changed

+259
-24
lines changed

4 files changed

+259
-24
lines changed

‎.all-contributorsrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"repoType": "github",
55
"repoHost": "https://github.com",
66
"files": [
7-
"README.md"
7+
"CONTRIBUTING.md"
88
],
99
"imageSize": 50,
1010
"commit": false,

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
[![All Contributors](https://img.shields.io/github/all-contributors/datastax/cassandra-data-migrator?color=ee8449&style=flat-square)](#contributors)
2+
3+
Cassandra Data Migrator is an ambitious project which aims to seamlessly migrate and validate between origin and target Apache Cassandra®-compatible clusters. There are *many* ways you can contribute! Please take a moment to review this document
4+
in order to make the contribution process easy and effective for everyone involved.
5+
6+
## Code of Conduct
7+
8+
This project follows a [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md). Please read
9+
through it at least once if you are going to contribute to Cassandra Data Migrator.
10+
11+
## Licensing
12+
13+
All source code in this repository is licensed exclusively under
14+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
15+
16+
## Jumping Right In
17+
18+
Some quick how-to docs have been written for some of the subject-matter
19+
areas in Cassandra Data Migrator. If you need an onramp that is not listed, here [let us know](https://github.com/datastax/cassandra-data-migrator/issues/new)!
20+
21+
## Contribution Ideas
22+
23+
There are lots of ways to contribute to the project. Some ideas on how to
24+
get started are described here.
25+
26+
### Feedback
27+
28+
- reporting issues - If you find an issue while using Cassandra Data Migrator, please [let us know](https://github.com/datastax/cassandra-data-migrator/issues/new)!
29+
30+
- reproducing issues - For some non-trivial bugs, it helps to have someone reproduce the issue.
31+
This can be helpful to help us understand better what conditions cause the issue to occur. If want to help
32+
address a non-trivial issue that has been reported, you can follow the steps that the original user
33+
reported. Updating issues with such findings is immensely helpful to the maintainers.
34+
35+
### Pull Requests
36+
37+
All contributions to this project are made in the form of pull requests, including:
38+
39+
- Easy Picks - Any issue labeled `easy pick` is a good first issue for new contributors. These are tagged
40+
by the maintainers specifically to provide a gentle on-ramp for those joining our endeavor.
41+
42+
- Fixing bugs - Bug fixes are awesome! If you submit a pull request with a bug fix, we will review it
43+
and provide feedback if refinements are needed. Otherwise we'll merge it in for the next release.
44+
45+
- Testing Improvements - Often, a good test is the best form of documentation. Test coverage can always
46+
be improved. Writing tests is also a great way to get familiar with the project up close.
47+
48+
- Writing documentation - Our users need good documentation. Good documentation is, however, a community
49+
effort. If you have used Cassandra Data Migrator and want to improve the journey for others, good documentation
50+
with examples is really helpful.
51+
52+
- Working on the core - The core machinery of Cassandra Data Migrator needs maintenance just like any code base. If you
53+
want to help implement new core features, manage project dependencies, address technical debt, or help
54+
with internal architecture, there is work to be done. This is on the more advanced end of contribution,
55+
and requires some study of the codebase. If you take the time to understand the code a bit before submitting
56+
pull requests, then the maintainers will take the time to help you make your pull requests better.
57+
58+
### Maintainers
59+
60+
We are looking for more community ownership in this project. That means that we will be supportive of
61+
new project contributors who wish to build a sense of trust with the maintainers.
62+
63+
- Reviewing Pull Requests - If you are a maintainer on this project, then
64+
you may be called on to review pull requests. Unless requested directly,
65+
pull requests will be allocated to reviewers automatically.
66+
67+
- Enforcing Conduct - You may be called up on as a maintainer of this
68+
project to enforce the code of conduct as it is written.
69+
70+
- Developing Maintainers - It is important that there be a solid core of
71+
project maintainers who can depend on one another and whom the project
72+
user base can depend on do govern the project fairly and equitably. As a
73+
project maintainer, you will be expected to help guide contributors as
74+
they learn about the project. You may be responsible for choosing
75+
maintainers or voting on maintainer membership.
76+
77+
- Documenting APIs - The developer docs are pretty lean right now. We need
78+
some examples of configuring and usage templates and so on. This level of
79+
contribution requires an intimate awareness of how the core engine works,
80+
but it is also some of the most valuable work that you can do in terms of
81+
expanding the Cassandra Data Migrator ecosystem. Contributions are welcome here!
82+
83+
84+
## Outreach
85+
86+
Help us get the word out on Cassandra Data Migrator. It is a newly opened project in its current form, and we
87+
are eager to get it into the hands of users who need it.
88+
89+
- Writing blog posts - A blog post that helps others see the good in
90+
Cassandra Data Migrator is a service to our community. This is even better when it
91+
comes from a new user who has seen the merit of the tooling. We
92+
appreciate any help.
93+
94+
- Helping other users - Helping new users get to a productive state is a
95+
great way to build bridges in the community. The more community
96+
advocates we have helping each other the better!
97+
98+
- Community Development - The Cassandra Data Migrator project endeavors to build a
99+
strong, inclusive, and robust support system around users and
100+
contributors alike. This takes on many forms. It is essential that we
101+
keep looking for ways to connect the Cassandra Data Migrator community, doing more of
102+
what works and less of what doesn't. If you want to help with community
103+
development, please join our
104+
[discord server](https://bit.ly/cassandra-workshop) and raise your hand!
105+
106+
## Contributors
107+
Thanks to these contributors! :sparkle:
108+
For recognizing contributions, please follow [this documentation](https://allcontributors.org/docs/en/bot/usage) and pick a key/contribution type from [here](https://allcontributors.org/docs/en/emoji-key).
109+
110+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
111+
<!-- prettier-ignore-start -->
112+
<!-- markdownlint-disable -->
113+
<table>
114+
<tbody>
115+
<tr>
116+
<td align="center" valign="top" width="16.66%"><a href="https://github.com/pravinbhat"><img src="https://avatars.githubusercontent.com/u/2746469?v=4?s=50" width="50px;" alt="Pravin Bhat"/><br /><sub><b>Pravin Bhat</b></sub></a><br /><a href="https://github.com/datastax/cassandra-data-migrator/commits?author=pravinbhat" title="Code">💻</a> <a href="#content-pravinbhat" title="Content">🖋</a> <a href="https://github.com/datastax/cassandra-data-migrator/commits?author=pravinbhat" title="Documentation">📖</a> <a href="#design-pravinbhat" title="Design">🎨</a> <a href="#maintenance-pravinbhat" title="Maintenance">🚧</a> <a href="https://github.com/datastax/cassandra-data-migrator/commits?author=pravinbhat" title="Tests">⚠️</a></td>
117+
</tr>
118+
</tbody>
119+
</table>
120+
121+
<!-- markdownlint-restore -->
122+
<!-- prettier-ignore-end -->
123+
124+
<!-- ALL-CONTRIBUTORS-LIST:END -->
125+
126+
---

‎README.md

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
[![All Contributors](https://img.shields.io/github/all-contributors/datastax/cassandra-data-migrator?color=ee8449&style=flat-square)](#contributors)
2-
31
# cassandra-data-migrator
42

53
Migrate and Validate Tables between Origin and Target Cassandra Clusters.
@@ -19,7 +17,7 @@ Migrate and Validate Tables between Origin and Target Cassandra Clusters.
1917

2018
```
2119
wget https://archive.apache.org/dist/spark/spark-3.3.1/spark-3.3.1-bin-hadoop3.tgz
22-
tar -xvzf <spark downloaded file name>
20+
tar -xvzf spark-3.3.1-bin-hadoop3.tgz
2321
```
2422

2523
### Build
@@ -104,23 +102,6 @@ This mode is specifically useful to processes a subset of partition-ranges that
104102
- Custom writetime
105103

106104
## Contributors
107-
Thanks to these contributors! :sparkle:
108-
For recognizing contributions, please follow [this documentation](https://allcontributors.org/docs/en/bot/usage) and pick a key/contribution type from [here](https://allcontributors.org/docs/en/emoji-key).
109-
110-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
111-
<!-- prettier-ignore-start -->
112-
<!-- markdownlint-disable -->
113-
<table>
114-
<tbody>
115-
<tr>
116-
<td align="center" valign="top" width="16.66%"><a href="https://github.com/pravinbhat"><img src="https://avatars.githubusercontent.com/u/2746469?v=4?s=50" width="50px;" alt="Pravin Bhat"/><br /><sub><b>Pravin Bhat</b></sub></a><br /><a href="https://github.com/datastax/cassandra-data-migrator/commits?author=pravinbhat" title="Code">💻</a> <a href="#content-pravinbhat" title="Content">🖋</a> <a href="https://github.com/datastax/cassandra-data-migrator/commits?author=pravinbhat" title="Documentation">📖</a> <a href="#design-pravinbhat" title="Design">🎨</a> <a href="#maintenance-pravinbhat" title="Maintenance">🚧</a> <a href="https://github.com/datastax/cassandra-data-migrator/commits?author=pravinbhat" title="Tests">⚠️</a></td>
117-
</tr>
118-
</tbody>
119-
</table>
120-
121-
<!-- markdownlint-restore -->
122-
<!-- prettier-ignore-end -->
123-
124-
<!-- ALL-CONTRIBUTORS-LIST:END -->
125-
126-
---
105+
Checkout all our wonderful contributors [here](./CONTRIBUTING.md#contributors).
106+
107+
---

0 commit comments

Comments
 (0)