You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,17 +59,27 @@ The AWS team managing the repository reserves the right to modify or reject new
59
59
versions, external dependencies, permissions, and runtime configuration. Use [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/java/KafkaConfigProviders/Kafka-SASL_SSL-ConfigProviders)
60
60
as a reference.
61
61
* Make sure the example works with what explained in the README, and without any implicit dependency or configuration.
62
+
* Add an entry for the new example in the top-level [README](README.md) or in the README of the subfolder, if the example is in a subfolder such as `java/FlinkCDC` or `java/Iceberg`
62
63
63
64
#### AWS authentication and credentials
64
65
65
66
* AWS credentials must never be explicitly passed to the application.
66
67
* Any permissions must be provided from the IAM Role assigned to the Managed Apache Flink application. When running locally, leverage the IDE AWS plugins.
67
68
68
69
#### Dependencies in PyFlink examples
69
-
* Use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/GettingStarted)
70
-
to provide JAR dependencies and build the ZIP using Maven.
71
-
* If the application also requires Python dependencies, use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/PythonDependencies)
72
-
leveraging `requirements.txt`.
70
+
71
+
* Use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/GettingStarted)
72
+
to provide JAR dependencies and build the ZIP using Maven.
73
+
* If the application also requires Python dependencies used for UDF and data processing in general, use the pattern illustrated by [this example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/PythonDependencies)
74
+
leveraging `requirements.txt`.
75
+
* Only if the application requires Python dependencies used during the job initialization, in the main(), use the pattern
76
+
illustrated in [this other example](https://github.com/aws-samples/amazon-managed-service-for-apache-flink-examples/tree/main/python/PackagedPythonDependencies),
77
+
packaging dependencies in the ZIP artifact.
78
+
79
+
#### Top POM-file for Java examples
80
+
81
+
* Add the new Java example also to the `pom.xml` file in the `java/` folder
0 commit comments