discussions icon indicating copy to clipboard operation
discussions copied to clipboard

Add a section in the README for ADRs.

Open bjohansebas opened this issue 1 year ago • 4 comments

Related #291

bjohansebas avatar Oct 28 '24 21:10 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?

bjohansebas avatar Oct 31 '24 00:10 bjohansebas

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

UlisesGascon avatar Oct 31 '24 15:10 UlisesGascon

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']
            })

jonchurch avatar Nov 02 '24 20:11 jonchurch

I updated it to remove the template and fix the meetings section in the readme.

bjohansebas avatar Feb 02 '25 23:02 bjohansebas