I wanted to note that the main source of truth for design discussions should be JIRA - GH PR interface should be mostly used for code comments and not design discussions.
This may not be clear for new contributors which are accustomed to the standard GH contribution workflow where design discussions take place entirely in the PR comments section, so we may want to point that out explicitly in the contributing guide. While GH PR comments get mirrored in the JIRA worklog the output is harder to navigate after the ticket is merged and the PR may not be available. It's also helpful to add a summary to the JIRA accompanied by a short comment of the approach taken when submitting the patch. I've seen an increasing amount of empty JIRAs being dumped without any description or reasoning behind decisions. On Mon, Aug 18, 2025 at 1:52 PM Joel Shepherd <sheph...@amazon.com> wrote: > > On 8/16/2025 2:39 AM, Mick wrote: > >> The important thing to know (but maybe not mention), which is on the > “how to commit” page, is that the GitHub PRs aren’t merged directly on > GitHub, they’re committed manually on the upstream git repo branch by > branch with an annotation to auto close them downstream on GitHub > > And GitHub are not a requirement either. > > > > Contributors are free to submit patches as any of the following: > > - GH PRs > > - GH fork+branches > > - patch files attached to the jira ticket > > Thanks all: appreciate folks pointing out the nuances. I'll make a pass > to clarify the options for contributors, and take a light hand on the > committer workflow on that page. > > Thanks -- Joel. > >
