[GitHub] [airflow] potiuk commented on issue #7191: [AIRFLOW-4030] second attempt to add singularity to airflow

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

potiuk commented on issue #7191: [AIRFLOW-4030] second attempt to add singularity to airflow
URL: https://github.com/apache/airflow/pull/7191#issuecomment-576467652
 
 
   > Also, could you give feedback on:
   > 
   > > Title Validator — Wrong commit title: adding singularity operator and tests
   > 
   > What is wrong about it?
   
   I think it's quite clearly described - it's about the "commit title". As mentioned in the PR description:
   
   > Commit message/PR title starts with [AIRFLOW-NNNN]. AIRFLOW-NNNN = JIRA ID*
   
   Commit message should start with [AIRFLOW-NNNN] similarly as PR description. You can run `git commit --amend` to change it and then `git push --force` to push it. It's also quite clearly described in the "Pull Request guidelines": https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines with example:
   
   > Preface your commit's subject & PR title with [AIRFLOW-XXX] COMMIT_MSG where XXX is the JIRA number. For example: [AIRFLOW-5574] Fix Google Analytics script loading. 
   
   I have a question @vsoch  - it seems that for some reason it is quite difficult to follow (for you at least). We have not only good and comprehensive documentation but also we have spend quite a lot of time to have messages printed either by the pre-commit system, or docs and require additional explanation (mostly repeating what is in the documentation already) - and pretty much careful reading the error messages could (I think) prevent asking extra questions - that was at least the goal. The messages are designed to guide you and In my answers I mostly repeat the messages already written there when you ask the question and link to already existing documentation. 
   
   I am really curious why it happens. Maybe we can improve it somehow - is the documentation not written clearly enough? Is there any problem with surfacing the error messages ? Or maybe there is a problem with finding relevant information? Or maybe you need more time to get familiar with the tools we are using ? 
   
   We tried (with professional technical writer) to place the documentation exactly where it is supposed to be, plus we push it exactly at the place where problems happen (for example in pre-commit checks) and try to make it as clear as possible - but apparently you still have problems with finding it. I am really curious - would it be possible for you to explain how are you approaching it, how are you reading (or maybe not?) the messages you get and how you are understanding (or not) what we try to communicate. 
   
   As a novice user you are the best "test" for it - maybe also you can have some ideas, proposals or maybe even a Pull Request that can improve it and make the documentation/messages better?
   
   Looking forward to more insight.
   

----------------------------------------------------------------
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