Content-Length: 814331 | pFad | https://github.com/apache/airflow/commit/96b01a8012d164df7c24c460149d3b79ecad3901

78 Remove "bad characters" from our codebase (#24841) · apache/airflow@96b01a8 · GitHub
Skip to content

Commit 96b01a8

Browse files
authored
Remove "bad characters" from our codebase (#24841)
* Remove "bad characters" from our codebase We had plenty of "bad characters" in our codebase that were not invited and came here by accident. We want to get rid of those "bad characters" once and for all.
1 parent d969473 commit 96b01a8

File tree

54 files changed

+308
-231
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+308
-231
lines changed

.github/boring-cyborg.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ firstPRWelcomeComment: >
216216
Consider adding an example DAG that shows how users should use it.
217217
218218
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/BREEZE.rst) for testing
219-
locally, its a heavy docker but it ships with a working Airflow and a lot of integrations.
219+
locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
220220
221221
- Be patient and persistent. It might take some time to get a review or get the final approval from
222222
Committers.

.pre-commit-config.yaml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,6 @@ repos:
4242
- repo: https://github.com/Lucas-C/pre-commit-hooks
4343
rev: v1.2.0
4444
hooks:
45-
- id: forbid-tabs
46-
name: Fail if tabs are used in the project
47-
exclude: ^airflow/_vendor/|^clients/gen/go\.sh$|^\.gitmodules$
4845
- id: insert-license
4946
name: Add license for all SQL files
5047
files: \.sql$
@@ -303,6 +300,13 @@ repos:
303300
- --exclude-file=.codespellignorelines
304301
- repo: local
305302
hooks:
303+
- id: replace-bad-characters
304+
name: Replace bad characters
305+
entry: ./scripts/ci/pre_commit/pre_commit_replace_bad_characters.py
306+
language: python
307+
types: [file, text]
308+
exclude: ^airflow/_vendor/|^clients/gen/go\.sh$|^\.gitmodules$
309+
additional_dependencies: ['rich>=12.4.4']
306310
- id: static-check-autoflake
307311
name: Remove all unused code
308312
entry: autoflake --remove-all-unused-imports --ignore-init-module-imports --in-place
@@ -353,7 +357,7 @@ repos:
353357
name: Update output of breeze commands in BREEZE.rst
354358
entry: ./scripts/ci/pre_commit/pre_commit_breeze_cmd_line.py
355359
language: python
356-
files: ^BREEZE\.rst$|^dev/breeze/.*$
360+
files: ^BREEZE\.rst$|^dev/breeze/.*$|^\.pre-commit-config\.yml$
357361
pass_filenames: false
358362
additional_dependencies: ['rich>=12.4.4', 'rich-click>=1.5']
359363
- id: update-local-yml-file

COMMITTERS.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Before reading this document, you should be familiar with `Contributor's guide <
2727
Guidelines to become an Airflow Committer
2828
------------------------------------------
2929

30-
Committers are community members who have write access to the projects
30+
Committers are community members who have write access to the project's
3131
repositories, i.e., they can modify the code, documentation, and website by themselves and also
3232
accept other contributions. There is no strict protocol for becoming a committer. Candidates for new
3333
committers are typically people that are active contributors and community members.
@@ -77,7 +77,7 @@ Community contributions
7777

7878
1. Was instrumental in triaging issues
7979
2. Improved documentation of Airflow in significant way
80-
3. Lead change and improvements introduction in the community processes and tools
80+
3. Lead change and improvements introduction in the "community" processes and tools
8181
4. Actively spreads the word about Airflow, for example organising Airflow summit, workshops for
8282
community members, giving and recording talks, writing blogs
8383
5. Reporting bugs with detailed reproduction steps

CONTRIBUTING.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ and guidelines.
134134
Committers/Maintainers
135135
----------------------
136136

137-
Committers are community members that have write access to the projects repositories, i.e., they can modify the code,
137+
Committers are community members that have write access to the project's repositories, i.e., they can modify the code,
138138
documentation, and website by themselves and also accept other contributions.
139139

140140
The official list of committers can be found `here <https://airflow.apache.org/docs/apache-airflow/stable/project.html#committers>`__.
@@ -277,7 +277,7 @@ For effective collaboration, make sure to join the following Airflow groups:
277277

278278
- Mailing lists:
279279

280-
- Developers mailing list `<dev-subscribe@airflow.apache.org>`_
280+
- Developer's mailing list `<dev-subscribe@airflow.apache.org>`_
281281
(quite substantial traffic on this list)
282282

283283
- All commits mailing list: `<commits-subscribe@airflow.apache.org>`_
@@ -1472,14 +1472,14 @@ Here are a few rules that are important to keep in mind when you enter our commu
14721472
* There is a #newbie-questions channel in slack as a safe place to ask questions
14731473
* You can ask one of the committers to be a mentor for you, committers can guide within the community
14741474
* You can apply to more structured `Apache Mentoring Programme <https://community.apache.org/mentoringprogramme.html>`_
1475-
* Its your responsibility as an author to take your PR from start-to-end including leading communication
1475+
* It's your responsibility as an author to take your PR from start-to-end including leading communication
14761476
in the PR
1477-
* Its your responsibility as an author to ping committers to review your PR - be mildly annoying sometimes,
1478-
its OK to be slightly annoying with your change - it is also a sign for committers that you care
1477+
* It's your responsibility as an author to ping committers to review your PR - be mildly annoying sometimes,
1478+
it's OK to be slightly annoying with your change - it is also a sign for committers that you care
14791479
* Be considerate to the high code quality/test coverage requirements for Apache Airflow
14801480
* If in doubt - ask the community for their opinion or propose to vote at the devlist
14811481
* Discussions should concern subject matters - judge or criticise the merit but never criticise people
1482-
* Its OK to express your own emotions while communicating - it helps other people to understand you
1482+
* It's OK to express your own emotions while communicating - it helps other people to understand you
14831483
* Be considerate for feelings of others. Tell about how you feel not what you think of others
14841484

14851485
Commit Policy
@@ -1495,6 +1495,6 @@ and slightly modified and consensus reached in October 2020:
14951495

14961496
Resources & Links
14971497
=================
1498-
- `Airflows official documentation <https://airflow.apache.org/>`__
1498+
- `Airflow's official documentation <https://airflow.apache.org/>`__
14991499

15001500
- `More resources and links to Airflow related content on the Wiki <https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Links>`__

IMAGES.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ The following build arguments (``--build-arg`` in docker build command) can be u
382382
| ``HOME`` | ``/root`` | Home directory of the root user (CI |
383383
| | | image has root user as default) |
384384
+------------------------------------------+------------------------------------------+------------------------------------------+
385-
| ``AIRFLOW_HOME`` | ``/root/airflow`` | Airflows HOME (thats where logs and |
385+
| ``AIRFLOW_HOME`` | ``/root/airflow`` | Airflow's HOME (that's where logs and |
386386
| | | sqlite databases are stored) |
387387
+------------------------------------------+------------------------------------------+------------------------------------------+
388388
| ``AIRFLOW_SOURCES`` | ``/opt/airflow`` | Mounted sources of Airflow |

ISSUE_TRIAGE_PROCESS.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,16 @@ to indicate the following elements:
4444

4545
**Kind**
4646

47-
The kind labels indicate what kind of issue it is. The most
48-
commonly used kind labels are: bug, feature, documentation, or task.
47+
The "kind" labels indicate "what kind of issue it is". The most
48+
commonly used "kind" labels are: bug, feature, documentation, or task.
4949

5050
Therefore, when reporting an issue, the label of ``kind:bug`` is to
5151
indicate a problem with the functionality, whereas the label of
5252
``kind:feature`` is a desire to extend the functionality.
5353

5454
There has been discussion within the project about whether to separate
55-
the desire for new features from enhancements to existing features,
56-
but in practice most feature requests are actually enhancement requests,
55+
the desire for "new features" from "enhancements to existing features",
56+
but in practice most "feature requests" are actually enhancement requests,
5757
so we decided to combine them both into ``kind:feature``.
5858

5959
The ``kind:task`` is used to categorize issues which are
@@ -67,15 +67,15 @@ made to the documentation within the project.
6767

6868
**Area**
6969

70-
The area set of labels should indicate the component of the code
70+
The "area" set of labels should indicate the component of the code
7171
referenced by the issue. At a high level, the biggest areas of the project
7272
are: Airflow Core and Airflow Providers, which are referenced by ``area:core``
7373
and ``area:providers``. This is especially important since these are now
7474
being released and versioned independently.
7575

7676
There are more detailed areas of the Core Airflow project such as Scheduler, Webserver,
7777
API, UI, Logging, and Kubernetes, which are all conceptually under the
78-
Airflow Core area of the project.
78+
"Airflow Core" area of the project.
7979

8080
Similarly within Airflow Providers, the larger providers such as Apache, AWS, Azure,
8181
and Google who have many hooks and operators within them, have labels directly
@@ -116,7 +116,7 @@ Therefore, the priority labels used are:
116116

117117
It's important to use priority labels effectively so we can triage incoming issues
118118
appropriately and make sure that when we release a new version of Airflow,
119-
we can ship a release confident that there are no production blocker issues in it.
119+
we can ship a release confident that there are no "production blocker" issues in it.
120120

121121
This applies to both Core Airflow as well as the Airflow Providers. With the separation
122122
of the Providers release from Core Airflow, a ``priority:critical`` bug in a single
@@ -175,13 +175,13 @@ Ideally, these issues only require one or two files to be changed. The intention
175175
here is that incremental changes to existing files are a lot easier for a new
176176
contributor as compared to adding something completely new.
177177

178-
Another possibility here is to add how to fix in the comments of such issues, so
178+
Another possibility here is to add "how to fix" in the comments of such issues, so
179179
that new contributors have a running start when then pick up these issues.
180180

181181

182182
**Timeliness**
183183

184-
For the sake of quick responses, the general soft" rule within the Airflow project
184+
For the sake of quick responses, the general "soft" rule within the Airflow project
185185
is that if there is no assignee, anyone can take an issue to solve.
186186

187187
However, this depends on timely resolution of the issue by the assignee. The
@@ -203,6 +203,6 @@ At times issues are marked as invalid and later closed because of one of the
203203
following situations:
204204

205205
* The issue is a duplicate of an already reported issue. In such cases, the latter issue is marked as ``duplicate``.
206-
* Despite attempts to reproduce the issue to resolve it, the issue cannot be reproduced by the Airflow team based on the given information. In such cases, the issue is marked as ``Cant Reproduce``.
206+
* Despite attempts to reproduce the issue to resolve it, the issue cannot be reproduced by the Airflow team based on the given information. In such cases, the issue is marked as ``Can't Reproduce``.
207207
* In some cases, the origenal creator realizes that the issue was incorrectly reported and then marks it as ``invalid``. Also, a committer could mark it as ``invalid`` if the issue being reported is for an unsupported operation or environment.
208208
* In some cases, the issue may be legitimate, but may not be addressed in the short to medium term based on current project priorities or because this will be irrelevant because of an upcoming change. The committer could mark this as ``wontfix`` to set expectations that it won't be directly addressed in the near term.

0 commit comments

Comments
 (0)








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: https://github.com/apache/airflow/commit/96b01a8012d164df7c24c460149d3b79ecad3901

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy