[
https://issues.apache.org/jira/browse/AIRFLOW-4738?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16856931#comment-16856931
]
ASF GitHub Bot commented on AIRFLOW-4738:
-----------------------------------------
mik-laj commented on pull request #5375: [AIRFLOW-4738] Enforce exampleinclude
for example DAGs
URL: https://github.com/apache/airflow/pull/5375
Make sure you have checked _all_ steps below.
### Jira
- [ ] My PR addresses the following [Airflow
Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references
them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- https://issues.apache.org/jira/browse/AIRFLOW-XXX
- In case you are fixing a typo in the documentation you can prepend your
commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- In case you are proposing a fundamental code change, you need to create
an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- In case you are adding a dependency, check if the license complies with
the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
### Description
We have a special directive in the project that allow to include a part of
source code to documentation. Unfortunately, Not everyone uses it.
Exampleinclude directive adds a header with a reference to the full source
code.
### Tests
- [ ] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
### Commits
- [ ] My commits all reference Jira issues in their subject lines, and I
have squashed multiple commits if they address the same issue. In addition, my
commits follow the guidelines from "[How to write a good git commit
message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
### Code Quality
- [ ] Passes `flake8`
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
> Enforce exampleinclude directive for example DAGs
> -------------------------------------------------
>
> Key: AIRFLOW-4738
> URL: https://issues.apache.org/jira/browse/AIRFLOW-4738
> Project: Apache Airflow
> Issue Type: New Feature
> Components: documentation
> Affects Versions: 1.10.3
> Reporter: Kamil Bregula
> Priority: Minor
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
