nprasad2077/airflow
1
0 Fork 0
mirror of https://github.com/apache/airflow.git synced 2026-11-04 07:12:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add description about Gen-AI contributions to our guide (#60158)

Browse Source 
* Add description about Gen-AI contributions to our guide

* Update contributing-docs/05_pull_requests.rst

Co-authored-by: Pierre Jeambrun <pierrejbrun@gmail.com>

* fixup! Update contributing-docs/05_pull_requests.rst

* Update contributing-docs/05_pull_requests.rst

Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>

---------

Co-authored-by: Pierre Jeambrun <pierrejbrun@gmail.com>
Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
This commit is contained in:
Jarek PotiukPierre JeambrunJed Cunningham
 authored and GitHub committed 2026-01-09 15:33:48 +01:00
1 parent 6181c3f3f5
commit 7d7908d1fb
4 files changed
+57 -33
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.gitattributes
+1
View File
@@ -15,6 +15,7 @@ scripts export-ignore
Dockerfile.ci export-ignore
CONTRIBUTING.rst export-ignore
ISSUE_TRIAGE_PROCESS.rst export-ignore
.github/PULL_REQUEST_TEMPLATE.md export-ignore
.asf.yaml export-ignore
.bash_completion export-ignore
.github/PULL_REQUEST_TEMPLATE.md
+25 -32
View File
@@ -1,44 +1,37 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
Thank you for contributing!
http://www.apache.org/licenses/LICENSE-2.0
Please provide above a brief description of the changes made in this pull request.
Write a good git commit message following this guide: http://chris.beams.io/posts/git-commit/
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Please make sure that your code changes are covered with tests.
And in case of new features or big changes remember to adjust the documentation.
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
Feel free to ping (in general) for the review if you do not see reaction for a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
* closes: #ISSUE
* related: #ISSUE
-->
## Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR, please
change below checkbox to `[X]` followed by the name of the tool, uncomment the "Generated-by".
-->
- [ ] Yes (please specify the tool below)
<!--
Generated-by: [Tool Name] following [the guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
* Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
* For fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment: `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
.pre-commit-config.yaml
+6 -1
View File
@@ -54,6 +54,9 @@ repos:
^docs/README\.md$|
^\.github/.*\.md$|
^airflow-core/tests/system/README\.md$
exclude:
(?x)
.github/PULL_REQUEST_TEMPLATE\.md$
args:
- "--maxlevel"
- "2"
@@ -155,13 +158,15 @@ repos:
- id: insert-license
name: Add license for all Markdown files
files: \.md$
exclude: PROVIDER_CHANGES.*\.md$
args:
- --comment-style
- "<!--|| -->"
- --license-filepath
- scripts/ci/license-templates/LICENSE.txt
- --fuzzy-match-generates-todo
exclude:
(?x)
.github/PULL_REQUEST_TEMPLATE\.md$
- id: insert-license
name: Add license for all other files
exclude: ^\.github/.*$
contributing-docs/05_pull_requests.rst
+25
View File
@@ -100,6 +100,31 @@ these guidelines:
- Adhere to guidelines for commit messages described in this `article <https://cbea.ms/git-commit/>`__.
This makes the lives of those who come after you (and your future self) a lot easier.
Gen-AI Assisted contributions
-----------------------------
Generally, it's fine to use Gen-AI tools to help you create Pull Requests for Apache Airflow as long as you
adhere to the following guidelines:
* Follow the `Apache Software Foundation (ASF) Generative Tooling guideliens <https://www.apache.org/legal/generative-tooling.html>`__.
* Ensure that you review and understand all code generated by Gen-AI tools before including it in your PR -
do not blindly trust the generated code.
* Make sure that the generated code adheres to the project's coding standards and best practices described
above
* Make sure to run all relevant static checks and tests locally to verify that the generated code works as
intended and does not introduce any issues.
* State in your PR description that you have used Gen-AI tools to assist in creating the PR.
* Be prepared to explain and justify the use of Gen-AI tools if asked by project maintainers or reviewers.
* Remember that the final responsibility for the code in your PR lies with you, regardless of whether
it was generated by a tool or written by you.
* By contributing code generated by Gen-AI tools, you agree to comply with the project's licensing terms
and any applicable laws and regulations.
* Blindly copy & pasting code from Gen-AI tools is detrimental as it might introduce security and
stability risks to the project. Maintainers that spot such behaviours will have no choice but to
close the related PRs. It adds extra burden on the maintainers and doesn't help the project.
The contributor reputation is also impacted as maintainers will lose confidence and might block
the user from making further contributions.
Requirement to resolve all conversations
----------------------------------------