[GitHub] [airflow] pgagnon commented on issue #5459: [AIRFLOW-XXX] Rewrite the contributing guide

[GitBox <gi...@apache.org>]

pgagnon commented on issue #5459: [AIRFLOW-XXX] Rewrite the contributing guide
URL: https://github.com/apache/airflow/pull/5459#issuecomment-505880416
 
 
   > @potiuk
   > 
   > > One proposal though - since this is quite a big change to CONTRIBUTING.md maybe we should also consider switching to .rst from .md ? I used an automated conversion tool in the past (I think any tool works here) and Github supports .rst rendering as well as .md
   > 
   > I'm not sure what the added benefit would be of that. I'd say either make all Markdown files (readme, contributing, todo & updating) in the root of the project .rst format or leave them as-is. One problem I encountered before was pictures in .rst files and the Github rendering didn't work nicely together. In my vague memory I used a raw tag together with a float to align the picture on the right and Github wouldn't render it correctly. Since the readme only shows images inline, I don't know if it would be a problem if we'd rewrite it to .rst files, something we would have to test.
   
   One benefit is that .rst files can be easily included in the generated documentation on https://airflow.apache.org/.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services