Squash history

Author: rampage644

CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CODING_CONVENTIONS.md

@@ -0,0 +1,50 @@
+# Coding Conventions used in Rust codebase of Embucket project
+
+## Design Conventions
+* Define errors with display messages in dedicated `errors.rs` files. Avoid inlining error texts outside of those files
+* Define `Error` enum and `Result<T>` types per crate, with public visibility
+* Implement `IntoResponse` trait for top-level error for API crates
+* Errors appeared in logs and tracing spans/events should also bring an error stack trace
+
+## Error Handling Conventions
+These conventions establish consistent practices for defining and handling errors in Rust crates using the [Snafu](https://docs.rs/snafu) error library, and `error_stack_trace::debug` proc macro enabling error stack trace.
+
+### Error Construction and Propagation
+* Derive from `Snafu` when defining error enums
+* Use proc macro `error_stack_trace::debug` to enable error stack traces
+* Restrict generated Snafu selectors' visibility to crate level: `#[snafu(visibility(pub(crate)))]`
+* Avoid constructing errors manually except in rare edge cases (e.g. boxed, non-Snafu, or external errors). Always document the reason when doing so.
+* Use Snafu’s helpers doing implicit error conversions under the hood:
+  * `.context(...)`, also supports chaining
+  * `.build()`
+  * `.fail()`
+  * `.into_error()`
+* Do implicit error conversions when propagate errors with `?` operator
+* These are preferred over `.map_err(...)` which is generally considered an anti-pattern due to loss of context and less ergonomic traceability
+
+### Defining Errors
+Define error enum with `#[derive(Snafu)]` and `#[error_stack_trace::debug]`:
+```
+#[derive(Snafu)]
+#[error_stack_trace::debug]
+pub enum Error {...}
+```
+### Non-Snafu foreign errors
+When nesting a non-Snafu foreign error - rename its field from `source` to `error`, and add `#[snafu(source)]` for Snafu context as shown below:
+```
+#[snafu(source)]
+error: ObjectStoreError,
+```
+### Boxing Large Errors
+When `clippy::result_large_err` is triggered, you may box the error variant. Put error into `Box<>` and add `From` trait implementation using:
+```
+#[snafu(source(from(S3tablesError, Box::new)))]
+source: Box<S3tablesError>,
+```
+Note: With Snafu, most use cases do not require manual boxing or unboxing. Let Snafu manage implicit conversions where possible.
+### Transparent Errors
+Define transparent error variant to re-use context and display message from the underlying error. No context selectors are generated for transparent errors, as error has no own context. And thus no `.context(...)` call can be used, but it still supports implicit `.into()` conversion, when used with `?`:
+```
+#[snafu(transparent)]
+error: SomeError,
+```

CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing
+Embucket is a streamlined solution for building and managing an open lakehouse platform based on the Apache Iceberg open table format. This project is designed to be radically simple, focusing on ease of deployment, operation, and maintenance.
+
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+We appreciate every contribution, whether it's fixing bugs, improving documentation, or adding new features — your efforts help make this project better for everyone.
+
+
+## Development environment setup
+
+To set up a development environment, please follow these steps:
+
+1. Clone the Embucket/embucket repository
+
+   ```sh
+   git clone https://github.com/Embucket/embucket.git
+   cd embucket/
+   ```
+   
+2. Build the project
+   ```sh
+   cargo build
+   ```
+
+
+## Issues and feature requests
+
+You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by. Before you create an issue, make sure to search the issue archive  [GithubIssues](https://github.com/Embucket/embucket/issues?q=is%3Aissue) your issue may have already been addressed!
+
+Please try to create bug reports that are:
+
+- _Reproducible._ Include steps to reproduce the problem.
+- _Specific._ Include as much detail as possible: which version, what environment, etc.
+- _Unique._ Do not duplicate existing opened issues.
+- _Scoped to a Single Bug._ One bug per report.
+
+**Even better: Submit a pull request with a fix or new feature!**
+
+### How to submit a Pull Request
+
+1. Search our repository for open or closed
+   [Pull Requests](https://github.com/Embucket/embucket/pulls)
+   that relate to your submission. You don't want to duplicate effort.
+2. Fork the project
+3. Create your feature branch (`git checkout -b issueID/new_feature`)
+4. Commit your changes (`git commit -m 'issue id: New Feature'`)
+5. Push to the branch (`git push origin issueID/new_feature`)
+6. [Open a Pull Request](https://github.com/Embucket/embucket/compare?expand=1)
+7. Your pull request build must pass (the build will run automatically).
+
+
+## Coding conventions
+
+When coding in Rust, please follow the [coding conventions](CODING_CONVENTIONS.md).
+
+
+## Getting Help
+For discussions, questions, or collaboration, feel free to reach out via [GitHub Discussions](https://github.com/Embucket/embucket/discussions). We appreciate your contributions and look forward to working with you!