Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minimal contributing guide #42

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Minimal contributing guide #42

merged 2 commits into from
Oct 31, 2024

Conversation

SemyonSinchenko
Copy link
Collaborator

@SemyonSinchenko SemyonSinchenko commented Oct 29, 2024

  • guide
  • fix & update links

Close #37

- guide
- fix & update links
docs/dev/contributing.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@zeotuan zeotuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look good to me overall. Just one small comment

@@ -3,7 +3,7 @@
A modern PySpark Connect/Classic wrapper on top of the Deequ, a beautiful Data Quality library from AWS Labs.


![](https://raw.githubusercontent.com/SemyonSinchenko/tsumugi-spark/main/static/tsumugi-spark-logo.png)
![](https://raw.githubusercontent.com/mrpowers-io/tsumugi-spark/main/static/tsumugi-spark-logo.png)

**_NOTE:_** _Tsumugi Shiraui is a chimera: a hybrid of Human and Gauna. She combines the chaotic power of Gauna with a Human intillegence and empathia. Like an original character of the Manga "Knights of Sidonia", this project aims to make a hybrid of very powerful but hard to learn and use Deequ Scala Library with a usability and simplicity of Spark Connect (PySpark Connect, Spark Connect Go, Spark Connect Rust, etc.)._

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not related to this PR but On line 12 there is a typo Lungauge can we include it in this PR

Copy link
Contributor

@0xbadidea 0xbadidea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation looks good to me.


## Running examples or testing clients

To simplify testing and development, there is a script that builds a server plugin, downloads and unpacks the Spark distribution, and runs the Spark Connect Server with all the necessary configurations. To run it, use `make run_spark_server`. After that, the server will be available at `sc://localhost:15002`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make run_spark_server results in a build error - [ERROR] /workspaces/tsumugi-spark/tsumugi-server/src/test/scala/com/ssinchenko/tsumugi/DeequUtilsTest.scala:66: type mismatch; found : scala.util.Try[com.amazon.deequ.VerificationRunBuilder] required: com.amazon.deequ.VerificationRunBuilder [ERROR] one error found

Changing the statement val deequSuite = DeequSuiteBuilder.protoToVerificationSuite(data, protoSuiteBuilder.build()) to val deequSuite = DeequSuiteBuilder.protoToVerificationSuite(data, protoSuiteBuilder.build()).getOrElse(throw new RuntimeException("Failed to create VerificationSuite")) in /workspaces/tsumugi-spark/tsumugi-server/src/test/scala/com/ssinchenko/tsumugi/DeequUtilsTest.scala and adding relevant imports resolved it, however my Scala is no good. Please have a look and use your judgement!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. I just realized that I somehow missed this in previous PR and we actually do not have automated testing for scala server. Will create a separate Issue to tackle this. Since it's not really related to this PR I will merge it in

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will try to fix the problem in this PR but we also need to run some minimal python client tests in CI

Copy link
Collaborator

@zeotuan zeotuan Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SemyonSinchenko Sorry Did not get updated on this. I figured we already have #40 which might be a good candidate for this?

@zeotuan zeotuan merged commit 3af9780 into main Oct 31, 2024
1 check passed
@SemyonSinchenko SemyonSinchenko deleted the contributing-docs branch November 27, 2024 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create CONTRIBUTING.md with a style guide
3 participants