This is an automated email from the ASF dual-hosted git repository.
nwang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-heron.git
The following commit(s) were added to refs/heads/master by this push:
new f1e6544 Add a spouts directory and README for spout implementations
(#3169)
f1e6544 is described below
commit f1e6544002efedbcfe8689d414c8629f895e9b41
Author: Ning Wang <[email protected]>
AuthorDate: Tue Feb 26 11:13:48 2019 -0800
Add a spouts directory and README for spout implementations (#3169)
* Add a spouts directory and README for spout impementations
* Add bolts dir
---
contrib/bolts/README.md | 36 ++++++++++++++++++++++++++++++++++++
contrib/spouts/README.md | 37 +++++++++++++++++++++++++++++++++++++
2 files changed, 73 insertions(+)
diff --git a/contrib/bolts/README.md b/contrib/bolts/README.md
new file mode 100644
index 0000000..cc1bd3a
--- /dev/null
+++ b/contrib/bolts/README.md
@@ -0,0 +1,36 @@
+
+This directory contains implementations of Heron bolts that can be used in
user topologies.
+
+The bolt implementations are maintained by Heron community.
+
+## Bolt Development
+
+- https://apache.github.io/incubator-heron/docs/developers/python/bolts/
+- https://apache.github.io/incubator-heron/docs/developers/java/bolts/
+
+
+## Requirements
+
+### Directories and Files
+
+Bolt implementation files should be organized in this directory structure:
+
+`external/bolts/{bolt_name}/{language}`
+
+Language: java, python, scala, etc
+bolt name: reduce_bolt, filter_bolt, etc
+
+Files in each bolt should be organized into these subdirectories:
+
+- `src/main/`: source code
+- `src/test/`: unit tests
+- `doc/` : documentations
+
+
+### Documentation
+
+Each bolt should have a design doc as well as related information in the doc/
directory.
+
+### License
+
+All source code files should include a short Apache license header at the top.
diff --git a/contrib/spouts/README.md b/contrib/spouts/README.md
new file mode 100644
index 0000000..e9222dc
--- /dev/null
+++ b/contrib/spouts/README.md
@@ -0,0 +1,37 @@
+
+This directory contains implementations of Heron spouts that can be used in
user topologies.
+
+The spout implementations are maintained by Heron community.
+
+## Spout Development
+
+- https://apache.github.io/incubator-heron/docs/developers/python/spouts/
+- https://apache.github.io/incubator-heron/docs/developers/java/spouts/
+
+
+## Requirements
+
+### Directories and Files
+
+Spout implementation files should be organized in this directory structure:
+
+`external/spouts/{client_name}/{language}/{spout_name}`
+
+Client name: kafka, pulsar, etc
+Language: java, python, scala, etc
+Spout name: kafka_spout, stateful_kafka_spout, etc
+
+Files in each spout should be organized into these subdirectories:
+
+- `src/main/`: source code
+- `src/test/`: unit tests
+- `doc/` : documentations
+
+
+### Documentation
+
+Each spout should have a design doc as well as related information in the doc/
directory.
+
+### License
+
+All source code files should include a short Apache license header at the top.
