ADR template for Pull Request

[bjohansebas]

Related #291

[wesleytodd]

I put request changes, but I think it is not truly something I consider blocking. I am just worried folks will be like me and need to go look up what "ADR" means to understand.

[wesleytodd]

Since I was not aware of the ADR format, I wonder if we could use more commonly used terminology here? RFC is the one I find most common and I know @sheplu even mentioned that on our call. That said, "proposal" would also make sense to me, and I think is more in the loose spirit of what these can be.

[UlisesGascon]

RFC sounds great! :)

[ctcpip]

an RFC is something different and I think we should prefer the semantically correct term for what this represents. RFC !== ADR

[bjohansebas]

I was thinking about this PR, and I don't think it's best to include all the content of the ADR as the message of the PR, as it would just duplicate the content that the PR would carry. Perhaps we should provide a message stating 'use the template located in X place' and add a section in the README educating about the ADRs. What do you think?

[UlisesGascon]

I think that is good idea @bjohansebas, so we only make changes in one place too.

[jonchurch]

I don't see the need for a PR template for this.

Functionally, unless it is the default PR template (named pull_request_template.md), the only way to open a PR w/ this template is via querystrings specifying the template name and visiting that link. People create workarounds for that but they're clunky.

The value I do see here is adding an ADR label. We can do that via an action like:
(PR #300)

name: ADR Labeler

on:
  pull_request:
    types: [opened, synchronize]
    paths:
      - 'docs/adr/**'

jobs:
  label-adr:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
    
    steps:
      - uses: actions/github-script@v7
        with:
          script: |
            # Adding ADR label - if it already exists, this is a no-op
            github.rest.issues.addLabels({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
              labels: ['ADR']
            })