Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added table of content in CONTRIBUTE.md and enhanced the documentation. #897

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

KesharwaniArpita
Copy link

No description provided.

@potiuk
Copy link
Member

potiuk commented Nov 20, 2023

This should be generated automtatically. We hve pre-commit for that in apache-airflow - so we should copy the pre-commit from there and generate the TOC automatically with it - this way it will be always "fresh"

https://github.com/apache/airflow/blob/main/.pre-commit-config.yaml#L30

@pierrejeambrun
Copy link
Member

pierrejeambrun commented Nov 22, 2023

+1 for auto generated TOC

Added doctoc as a pre-commit hook for automatic TOC generation.
Modified .pre-commit-config.yaml to include the new hook.
@potiuk
Copy link
Member

potiuk commented Dec 3, 2023

You also need to actually use the pre-commit to generate the content :)

@potiuk
Copy link
Member

potiuk commented Dec 3, 2023

And remove the one added by hand

@potiuk
Copy link
Member

potiuk commented Dec 3, 2023

@potiuk
Copy link
Member

potiuk commented Dec 5, 2023

Well. You do realize you need to run pre-commit and apply the change though :) ?

@KesharwaniArpita
Copy link
Author

Well. You do realize you need to run pre-commit and apply the change though :) ?

I did. I run the pre-commit run --all-files as mentioned in the file. Is there anything else I need to do?
I would really appreciate it if you could tell me.

@potiuk
Copy link
Member

potiuk commented Dec 6, 2023

I did. I run the pre-commit run --all-files as mentioned in the [file](https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#id3). Is there anything else I need to do? I would really appreciate it if you could tell me.

Well it does not look like because the same thing in CI produced different result.

@potiuk
Copy link
Member

potiuk commented Dec 6, 2023

image

@potiuk
Copy link
Member

potiuk commented Dec 6, 2023

I think this output of the CI explains everything. I would have to literally copy what it says if you want instructions :)

It's there precisely to instruct people what to do

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants