Re: [PR] Docs: add review checklist for example DAGs [airflow]
potiuk commented on PR #61786: URL: https://github.com/apache/airflow/pull/61786#issuecomment-4178107714 This pull request has been converted to draft due to quality issues more than a week ago and there has been no response from the author. **@Chandanakt**, you are welcome to reopen this PR when you are ready to continue working on it. Thank you for your contribution! -- 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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
potiuk closed pull request #61786: Docs: add review checklist for example DAGs URL: https://github.com/apache/airflow/pull/61786 -- 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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
potiuk commented on PR #61786: URL: https://github.com/apache/airflow/pull/61786#issuecomment-4035044674 @Chandanakt This PR has been converted to **draft** because it does not yet meet our [Pull Request quality criteria](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-quality-criteria). **Issues found:** - :x: **Pre-commit / static checks**: Failing: Basic tests / Static checks: basic checks only. Run `prek run --from-ref main` locally to find and fix issues. See [Pre-commit / static checks docs](https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst). > **Note:** Your branch is **832 commits behind `main`**. Some check failures may be caused by changes in the base branch rather than by your PR. Please rebase your branch and push again to get up-to-date CI results. **What to do next:** - The comment informs you what you need to do. - Fix each issue, then mark the PR as "Ready for review" in the GitHub UI - but only after making sure that all the issues are fixed. - Maintainers will then proceed with a normal review. Converting a PR to draft is **not** a rejection — it is an invitation to bring the PR up to the project's standards so that maintainer review time is spent productively. If you have questions, feel free to ask on the [Airflow Slack](https://s.apache.org/airflow-slack). -- 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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
Chandanakt commented on PR #61786: URL: https://github.com/apache/airflow/pull/61786#issuecomment-3900913011 Thanks for the review and approval! Happy to move it if a different location is preferred. -- 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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
Chandanakt commented on PR #61786: URL: https://github.com/apache/airflow/pull/61786#issuecomment-3894963811 @jscheffl , I have updated the PR by resolving RST title formatting issue. Would appreciate your review when you have time. Thanks! -- 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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
Chandanakt commented on PR #61786: URL: https://github.com/apache/airflow/pull/61786#issuecomment-3891767807 @jscheffl , Thanks for the suggestions! I’ve added a link to PEP 8 and updated the capitalization to use "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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
Chandanakt commented on code in PR #61786: URL: https://github.com/apache/airflow/pull/61786#discussion_r2799559978 ## 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: Ok, I will update it. -- 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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
Chandanakt commented on code in PR #61786: URL: https://github.com/apache/airflow/pull/61786#discussion_r2799556123 ## 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: ok I'll make the changes -- 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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
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]
Re: [PR] Docs: add review checklist for example DAGs [airflow]
boring-cyborg[bot] commented on PR #61786: URL: https://github.com/apache/airflow/pull/61786#issuecomment-3886031226 Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst) Here are some useful points: - Pay attention to the quality of your code (ruff, mypy and type annotations). Our [prek-hooks]( https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#prerequisites-for-prek-hooks) will help you with that. - In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/airflow-core/docs/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it. - Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst) for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations. - Be patient and persistent. It might take some time to get a review or get the final approval from Committers. - Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack. - Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#coding-style-and-best-practices). - Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits. Apache Airflow is a community-driven project and together we are making it better 🚀. In case of doubts contact the developers at: Mailing List: [email protected] Slack: https://s.apache.org/airflow-slack -- 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]
