Poorvankbhatia commented on code in PR #6: URL: https://github.com/apache/flink-connector-redis-streams/pull/6#discussion_r3006409966
########## .gitignore: ########## @@ -1,38 +1,48 @@ -.eslintcache -.cache -scalastyle-output.xml +# Maven Review Comment: This replaces the repository's existing .gitignore (which matched the standard Flink connector template used by [Kafka](https://github.com/apache/flink-connector-kafka/blob/main/.gitignore), [Cassandra](https://github.com/apache/flink-connector-cassandra/blob/main/.gitignore), and [JDBC](https://github.com/apache/flink-connector-jdbc/blob/main/.gitignore) connectors) with a generic template. This loses critical entries: *.jar, *.zip, tools/japicmp-output, build-target, docs/ build artifacts, and the surgical .idea/* + !.idea/vcs.xml pattern (which preserves VCS config for contributors). It adds entries that don't belong in a Maven project (dist/, build/, lib/, bin/). Please revert to the original .gitignore and add only the entries specifically needed for the Redis connector. If not, please add a comment on why this is being replaced. ########## .gitignore: ########## @@ -1,38 +1,48 @@ -.eslintcache -.cache -scalastyle-output.xml +# Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties +dependency-reduced-pom.xml +buildNumber.properties +.mvn/timing.properties +.mvn/wrapper/maven-wrapper.jar + +# Eclipse +.project .classpath -.idea/* -!.idea/vcs.xml +.settings/ .metadata -.settings -.project -.version.properties -filter.properties -logs.zip -.mvn/wrapper/*.jar -target -tmp -*.class +bin/ Review Comment: **/bin** can also be a legit directory name for scripts. Any reason for adding this? ########## README.md: ########## @@ -1 +1,161 @@ -# flink-connector-redis +# Apache Flink Redis Streams Connector Review Comment: Again, the repository's README should follow the standard Apache Flink connector template (again identical to Kafka, Cassandra and other connectors): build prerequisites, clone/build instructions, IDE setup, mailing lists, JIRA, contribution guide, and ASF boilerplate. User-facing API documentation with code examples belongs in docs/ on the Flink website, not in the repo README. Please take a look at other connectors for reference. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
