paul-rogers commented on issue #1921: DRILL-7478: Add Pull Request Template
URL: https://github.com/apache/drill/pull/1921#issuecomment-570005377
 
 
   To move this along, I'd like to propose we that have two files. The first 
would be a "Contributing.md" file in the Drill root directory. As a Markdown 
file, it can be easily viewed by clicking on it. Perhaps add a link to the file 
from the "README.md" file that shows by default in Github. In this file, add 
all the contribution guidelines, pointers to style, how to run unit tests, 
checklist for contributors, and so on. We can make this file as verbose as 
needed.
   
   Then, have a separate PR template that is concise. Perhaps:
   
   ```
   <Title should be DRILL-XXXX: Fix Summary>
   <describe the change. If more than one ticket is fixed, include a reference 
to those tickets.)
   
   ## Documentation
   
   <Describe user-visible changes in a form close to what should appear in 
documentation.>
   
   ## Tests
   
   <Describe tests including new unit or other tests added which cover the 
change.>
   ```

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


With regards,
Apache Git Services

Reply via email to