Skip to content

Commit 643b93c

Browse files
chore: add "why rust?" section (#7)
Adds a "why rust?" section based on thoughts in the slack. Closes #4. Also updates the Code of Conduct from the main Java repo (thank you @dennyglee!) --------- Co-authored-by: Danny Lee <denny.g.lee@gmail.com>
1 parent f9ebec9 commit 643b93c

File tree

4 files changed

+147
-15
lines changed

4 files changed

+147
-15
lines changed

CODE_OF_CONDUCT.md

Lines changed: 131 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,132 @@
1-
# Code of Conduct
1+
# Contributor Covenant Code of Conduct
22

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

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ wish to make by creating a new issue before making the change.
88
## Reporting issues
99

1010
Before reporting an issue on the
11-
[issue tracker](https://github.com/abrassel/unitycatalog-rs/issues),
11+
[issue tracker](https://github.com/unitycatalog/unitycatalog-rs/issues),
1212
please check that it has not already been reported by searching for some related
1313
keywords.
1414

@@ -19,7 +19,7 @@ Try to do one pull request per change.
1919
### Updating the changelog
2020

2121
Update the changes you have made in
22-
[CHANGELOG](https://github.com/abrassel/unitycatalog-rs/blob/main/CHANGELOG.md)
22+
[CHANGELOG](https://github.com/unitycatalog/unitycatalog-rs/blob/main/CHANGELOG.md)
2323
file under the **Unreleased** section.
2424

2525
Add the changes of your pull request to one of the following subsections,
@@ -42,7 +42,7 @@ If the required subsection does not exist yet under **Unreleased**, create it!
4242
This is no different than other Rust projects.
4343

4444
```shell
45-
git clone https://github.com/abrassel/unitycatalog-rs
45+
git clone https://github.com/unitycatalog/unitycatalog-rs
4646
cd unitycatalog-rs
4747
cargo test
4848
```

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# unitycatalog-rs
22

3-
[![Crates.io](https://img.shields.io/crates/v/unitycatalog-rs.svg)](https://crates.io/crates/unitycatalog-rs)
4-
[![Docs.rs](https://docs.rs/unitycatalog-rs/badge.svg)](https://docs.rs/unitycatalog-rs)
5-
[![CI](https://github.com/abrassel/unitycatalog-rs/workflows/CI/badge.svg)](https://github.com/abrassel/unitycatalog-rs/actions)
6-
[![Rust GitHub Template](https://img.shields.io/badge/Rust%20GitHub-Template-blue)](https://rust-github.github.io/)
3+
[![CI](https://github.com/unitycatalog/unitycatalog-rs/workflows/CI/badge.svg)](https://github.com/unitycatalog/unitycatalog-rs/actions) ![crates.io](https://img.shields.io/crates/v/unitycatalog.svg?label=unitycatalog) ![crates.io](https://img.shields.io/crates/v/unitycatalog-client.svg?label=unitycatalog-client) ![crates.io](https://img.shields.io/crates/v/unitycatalog-sys.svg?label=unitycatalog-sys)
74

5+
unitycatalog-rs serves an alternate implementation of the [Unity Catalog protocol](https://github.com/unitycatalog/unitycatalog/tree/main/api). The Unity Catalog protocol is a specification for a multi-modal catalog for data and AI assets.
86

9-
## Installation
7+
## Why Rust?
108

11-
### Cargo
9+
Rust was chosen as a language for the second implementation for a few reasons:
1210

13-
* Install the rust toolchain in order to have cargo installed by following
14-
[this](https://www.rust-lang.org/tools/install) guide.
15-
* run `cargo install unitycatalog-rs`
11+
- **Performance**: Rust compiles to native bytecode, enabling it to be used in performance-critical and constrained environments.
12+
- **FFI**: As Rust uses the C ABI, bindings can be exposed to any language, like C, Go, etc.
13+
- **Python & Rust**: Python and Rust are a strong pairing, especially in the AI ecosystem ([tokenizers](https://github.com/huggingface/tokenizers), [pydantic](https://github.com/pydantic/pydantic-core), etc).
14+
- **Ecosystem**: Rust has a rich ecosystem of libraries, especially related to big data processing ([delta-rs](https://github.com/delta-io/delta-rs), [datafusion](https://github.com/apache/datafusion), etc).
15+
- **Safety**: Rust's strong type system and ownership model make it difficult to write code that is unsafe or has undefined behavior. When dealing with data assets, especially when it comes to access control, this helps us ensure that we are not introducing security vulnerabilities.
16+
- **We want to write it!**: Most importantly, we like writing Rust!
1617

1718
## License
1819

models/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Rust=generated structs for Unity Catalog
1+
# Rust-generated structs for Unity Catalog
2+
3+
![crates.io](https://img.shields.io/crates/v/unitycatalog-sys.svg)
24

35
## Overview
46

0 commit comments

Comments
 (0)