Hi Cole, I've definitely found that new contributors are often confused on which branch to target so I think this is an issue that needs to be solved. I'm not sure if PR template is the right solution to this problem, but I think it's a reasonable first step so I'm all for trying it.
The other item that people often leave out is the CHANGELOG entry and sometimes UPGRADE documentation. There is also sometimes confusion on where to add the entry to those documents so I think adding some information about that would be useful as well. I think it's one of those inconveniences to contributors as sometimes the only review comment they get is something like "needs CHANGELOG entry". Regards, Ken On Tue, Jun 11, 2024 at 2:10 PM Cole Greer <cole.gr...@improving.com.invalid> wrote: > Hey everyone, > > A topic that has come up a few times in the past is adding a PR template > to our repo. I would like to kick off an official discussion before adding > one to the repo. > > My suggestion is to use the Spark PR template ( > https://github.com/apache/spark/blob/v3.5.1/.github/PULL_REQUEST_TEMPLATE) > as a reference and make some small updates to link to our docs and better > fit our process. The main TP specific details I would like to add is > guidance about which branch the PR should target, as well as a reminder to > properly reference any related JIRAs or devlist posts. > > I don’t expect we would be strict with template adherence, but I think it > would help guide newer contributors in the right direction. Let me know any > thoughts you have, and if there are other instructions which should be > included in the template. My plan is to draft up a template including any > feedback here sometime this week. > > Thanks, > Cole >
