This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-connect-go.git
The following commit(s) were added to refs/heads/main by this push:
new bb8e2a7 [MINOR] Update README and CONTRIBUTING (#2)
bb8e2a7 is described below
commit bb8e2a784f18a57e3d913e5e8ece92b66cc7a8b0
Author: Martin Grund <martin.gr...@databricks.com>
AuthorDate: Tue May 30 13:18:53 2023 +0200
[MINOR] Update README and CONTRIBUTING (#2)
This patch adds some additional background to the README file and adds some
guidelines to contributing similar to the Spark project.
---
CONTRIBUTING.md | 16 ++++++++++++++++
README.md | 17 ++++++++++++++++-
2 files changed, 32 insertions(+), 1 deletion(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..4e5a578
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+## Contributing to Spark
+
+*Before opening a pull request*, review the
+[Contributing to Spark guide](https://spark.apache.org/contributing.html).
+It lists steps that are required before creating a PR. In particular, consider:
+
+- Is the change important and ready enough to ask the community to spend time
reviewing?
+- Have you searched for existing, related JIRAs and pull requests?
+- Is this a new feature that can stand alone as a [third party
project](https://spark.apache.org/third-party-projects.html) ?
+- Is the change being proposed clearly explained and motivated?
+
+When you contribute code, you affirm that the contribution is your original
work and that you
+license the work to the project under the project's open source license.
Whether or not you
+state this explicitly, by submitting any copyrighted material via pull
request, email, or
+other means you agree to license the material under the project's open source
license and
+warrant that you have the legal authority to do so.
\ No newline at end of file
diff --git a/README.md b/README.md
index 79b03d6..beaeaeb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
# Apache Spark Connect Client for Golang
-Experimental
+This project houses the **experimental** client for [Spark
+Connect](https://spark.apache.org/docs/latest/spark-connect-overview.html) for
+[Apache Spark](https://spark.apache.org/) written in [Golang](https://go.dev/).
+
+
+## Current State of the Project
+
+Currently, the Spark Connect client for Golang is highly experimental and
should
+not be used in any production setting. In addition, the PMC of the Apache Spark
+project reserves the right to withdraw and abandon the development of this
project
+if it is not sustainable.
+
+## Contributing
+
+Please review the [Contribution to Spark
guide](https://spark.apache.org/contributing.html)
+for information on how to get started contributing to the project.
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
