[GitHub] [drill] paul-rogers commented on issue #1921: DRILL-7478: Add Pull Request Template
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: ``` ## Tests ``` 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
[GitHub] [drill] paul-rogers commented on issue #1921: DRILL-7478: Add Pull Request Template
paul-rogers commented on issue #1921: DRILL-7478: Add Pull Request Template URL: https://github.com/apache/drill/pull/1921#issuecomment-565149077 Makes sense. Maybe provide the commit template that gives the gist of the change. (The JIRA number is not sufficient, requires a check or JIRA just to find out, say, that this was upgrading library X to a new version.) I like the pattern you have used: to create a README file to explain things. That becomes a permanent source of documentation. For other cases, a `.md` file or `package-info.java` can serve the same purpose. This leaves the PR note. It should include the same info as the commit (though perhaps in another form.) We can offer two parts: 1. Outline of the topics that might be covered, if relevant. (Just omit the bits that don't apply rather than filling in "Does not apply.") This is where the (reformatted) commit message would go. 2. Checklist of common tasks. The author is free to remove those that don't apply (such a "check license terms for any new libraries" if no libraries are added.) Add those that do apply to this case. 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
[GitHub] [drill] paul-rogers commented on issue #1921: DRILL-7478: Add Pull Request Template
paul-rogers commented on issue #1921: DRILL-7478: Add Pull Request Template URL: https://github.com/apache/drill/pull/1921#issuecomment-564868743 What is the intent here? Looks like this PR is trying to solve two problems: 1. Provide a standard template for PR messages, 2. Provide a checklist of things we want the contributer to do. I wonder, should we think about the *commit* message; the one that will travel with the code in Git? For the commit message, a simple template would be helpful: ``` DRILL-: Summary Description of change. ``` I have seen folks include only the bug number. (Of course, I'm not sure anyone ever reads the commit messages...) For the PR message, do we insist people keep our headings? Only our headings? Should they replace the commit message with a differently worded message? That is, do we want people to describe the change twice, in two different ways? Each time I've seen shops provide these templates, it ends up that either the templates are off the mark, or they grow to be cumbersome. They are no substitute for people just doing the right thing. A good reviewer will look for tests (I do that first.) A `pom.xml` file change should be carefully reviewed. What are we solving by adding a template? 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
