I like auto linking, definitely a handy feature. I am not sure about the content of the pull request description. I would include what that PR is actually for / why it is necessary to merge it and into what branches a contributor expects that PR to be merged in. However, this might be omitted if all this information is in a JIRA ticket already, I find the correct auto linking to be the most crucial here.
There might be a bullet point for adding relevant CI builds (Jenkins or Circle). I am not sure we are going to enforce a commit message to start with the issue number. The issue number is already mentioned in the commit message. I feel like this kind of stuff is not crucial for a PR to be opened, a committer who is actually going to merge it will take extra time and care when it comes to these formalities anyway. The reason why a PR should be merged should be the priority. On Mon, 15 Aug 2022 at 10:41, Claude Warren, Jr via dev <dev@cassandra.apache.org> wrote: > > Github provides the ability to add a pull request template [1]. I think that > such a template could assist in making the pull requests better. Something > like the text below, along with verifying that CASSANDRA-### will link to > Jira [2], should provide the information needed and remind submitters of what > is desired. > > If there is agreement here, I'll open a pull request to add the documentation > and ask Apache devops to verify that the CASSANDRA-### will link to Jira. > > Claude > > [1] > https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository > for more information. > [2] > https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources > > ----- start of text > > Issue resolved # CASSANDRA- > > Pull request Description: > > > > ---- > > - [ ] Commits have been squashed to remove intermediate development commit > messages. > - [ ] Key commit messages start with the issue number (CASSANDRA-xxxx) > > > either > - [ ] this is a trivial documentation change. (e.g. fixes a typo) > > or: > - [ ] Tests are included. > - [ ] Documentation changes and/or updates are included. > > > By submitting this pull request, I acknowledge that I am making a > contribution to the Apache Software Foundation under the terms and conditions > of the [Contributor's > Agreement](https://www.apache.org/licenses/contributor-agreements.html). > > ---- > > See the [Apache Cassandra "Contributing to Cassandra" > guide](https://cassandra.apache.org/_/development/index.html) and/or the > [Apache Cassandra "Working on Documentation" > guide](https://cassandra.apache.org/_/development/documentation.html)
