-
Notifications
You must be signed in to change notification settings - Fork 301
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
base: main
Are you sure you want to change the base?
Conversation
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 |
+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.
You also need to actually use the pre-commit to generate the content :) |
And remove the one added by hand |
Well. You do realize you need to run pre-commit and apply the change though :) ? |
I did. I run the |
Well it does not look like because the same thing in CI produced different result. |
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 |
No description provided.