jscheffl commented on code in PR #61786: URL: https://github.com/apache/airflow/pull/61786#discussion_r2795538824
########## contributing-docs/example_dag_review_checklist.rst: ########## @@ -0,0 +1,79 @@ +Example DAG Review Checklist +============================ + +This document provides a checklist for reviewing example DAGs submitted to +Apache Airflow. The goal is to ensure that example DAGs are clean, consistent, +and follow best practices while serving their multiple purposes: + +* Clean and consistent +* Easy to understand +* Useful for tutorials and documentation +* Compatible with testing and CI processes +* Properly structured across core and provider packages + +General Guidelines +------------------ + +- [ ] The DAG has a clear and descriptive file name. +- [ ] The purpose of the DAG is documented at the top of the file. +- [ ] The DAG demonstrates a single feature or concept. +- [ ] Examples do not duplicate functionality across the repo. +- [ ] Example runs in a reasonable amount of time (suitable for tutorials & CI). + +Example Categorization +---------------------- + +Example DAGs should clearly indicate which category they belong to: + +- [ ] **Tutorial Examples** — educational, simple to read and follow. +- [ ] **Documentation Snippets** — aligned with docs examples. +- [ ] **Testing/CI Examples** — used to exercise system features in CI. +- [ ] Example type is noted in module-level docstring or metadata. + +Structure & Readability +----------------------- + +- [ ] The DAG and task IDs are meaningful and consistent. +- [ ] The code follows PEP 8 formatting. Review Comment: A Link would be good to PEP8 ########## contributing-docs/example_dag_review_checklist.rst: ########## @@ -0,0 +1,79 @@ +Example DAG Review Checklist +============================ + +This document provides a checklist for reviewing example DAGs submitted to +Apache Airflow. The goal is to ensure that example DAGs are clean, consistent, +and follow best practices while serving their multiple purposes: + +* Clean and consistent +* Easy to understand +* Useful for tutorials and documentation +* Compatible with testing and CI processes +* Properly structured across core and provider packages + +General Guidelines +------------------ + +- [ ] The DAG has a clear and descriptive file name. Review Comment: We recently decided to have the term "DAG" always written as "Dag" (a couple of docs and docstring might still having the old typing). Can you please adjust this to be "Dag" consistently? -- 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]
