This is an automated email from the ASF dual-hosted git repository.
jackie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pinot.git
The following commit(s) were added to refs/heads/master by this push:
new 0f98672fb3 Update README.md to mention new important Maven profiles
(#14039)
0f98672fb3 is described below
commit 0f98672fb31376c9a8b5622dff0e6fde2067e4a3
Author: Gonzalo Ortiz Jaureguizar <[email protected]>
AuthorDate: Thu Sep 19 22:15:30 2024 +0200
Update README.md to mention new important Maven profiles (#14039)
---
README.md | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f39ad1a3b1..6325bb11ce 100644
--- a/README.md
+++ b/README.md
@@ -87,6 +87,15 @@ SELECT sum(clicks), sum(impressions) FROM AdAnalyticsTable
daysSinceEpoch TOP 100
```
+## Contributing to Pinot
+Please refer to the [Contribution
Guide](https://docs.pinot.apache.org/community/contribution) for
+more information on how to contribute to Apache Pinot.
+
+Normal Pinot builds are done using the `mvn clean install` command.
+However this command can take a long time to run.
+For faster builds it is recommended to use `mvn verify -Ppinot-fastdev`, which
disables some plugins that are not
+actually needed for development.
+
## Building Pinot
More detailed instructions can be found at [Quick
Demo](https://docs.pinot.apache.org/basics/getting-started/quick-start) section
in the documentation.
```
@@ -95,7 +104,9 @@ $ git clone https://github.com/apache/pinot.git
$ cd pinot
# Build Pinot
-$ mvn clean install -DskipTests -Pbin-dist
+# -Pbin-dist is required to build the binary distribution
+# -Pbuild-shaded-jar is required to build the shaded jar, which is necessary
for some features like spark connectors
+$ mvn clean install -DskipTests -Pbin-dist -Pbuild-shaded-jar
# Run the Quick Demo
$ cd build/
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
