process: include deputies in README Owner entries #2350

pull jonatack wants to merge 3 commits into bitcoin:master from jonatack:2026-11-include-deputies-in-readme changing 3 files +18 −6
  1. jonatack commented at 5:46 PM on November 9, 2026: member

    updates the CI and adds a clarifying sentence in BIP 3, per discussion in #2343 (comment).

  2. script: buildtable checks deputy inclusion in readme c2497beafd
  3. bip3: clarify deputy inclusion in readme owner entry d853786cd8
  4. jonatack commented at 5:48 PM on November 9, 2026: member

    cc BIP 3 author @murchandamus

  5. in scripts/buildtable.pl:186 in d853786cd8 outdated
     181 | +			$emails{$deputyname}->{$deputyemail} = undef;
     182 | +			if (defined $authors) {
     183 | +				$authors .= ", $deputyname";
     184 | +			} else {
     185 | +				$authors = $deputyname;
     186 | +			}
    


    jonatack commented at 5:51 PM on November 9, 2026:

    Alternative possible version: the first version mirrors the Authors logic (full regex + email storage in %emails) for consistency. However, since Deputies are already in %EmailField, the check already validates the Name <email> format, so we could optionally only extract the name and append it.

    +		} elsif ($field eq 'Deputies') {
    +			$val =~ m/^(\S[^<@>]*\S) </ or die "Malformed Deputies line in $fn";
    +			my $deputyname = $1;
    +			if (defined $authors) {
    +				$authors .= ", $deputyname";
    +			} else {
    +				$authors = $deputyname;
    +			}
    

    murchandamus commented at 6:26 PM on November 9, 2026:

    I’d prefer if both the checks are of the same shape and I don’t mind the belt and suspenders here of checking the same thing twice. Even though that might make it easier to introduce a discrepancy in the future, I don’t anticipate that a regex for Name + Email would be modified frequently.

    So, if we decided to go this way, I would suggest that we apply the same modification to the Authors check. It would however make more sense to me to just replace this script with one in a language that’s not “write-only” such as Python.


    jonatack commented at 7:30 PM on November 9, 2026:

    Agree on same shape and keeping the check. LMK if you were thinking of a further change at this time.

  6. in scripts/buildtable.pl:183 in d853786cd8
     178 | +			$val =~ m/^(\S[^<@>]*\S) \<([^@>]*\@[\w.-]+\.\w+)\>$/ or die "Malformed Deputies line in $fn";
     179 | +			my ($deputyname, $deputyemail) = ($1, $2);
     180 | +			$deputyemail =~ s/(?<=\D)$bipnum(?=\D)/<BIPNUM>/g;
     181 | +			$emails{$deputyname}->{$deputyemail} = undef;
     182 | +			if (defined $authors) {
     183 | +				$authors .= ", $deputyname";
    


    murchandamus commented at 6:22 PM on November 9, 2026:

    Perhaps the $authors variable should now also be renamed to $owners to better express the shifted context.


    jonatack commented at 7:29 PM on November 9, 2026:

    Good idea, added a refactor commit for the renaming.

  7. murchandamus commented at 6:26 PM on November 9, 2026: member

    Concept ACK, some suggestions.

  8. script, refactor: rename authors to owners where relevant 7bf26a7109
  9. jonatack commented at 7:39 PM on November 9, 2026: member

    The change here also enforces the grouping order {authors, deputies} in the readme. I think this makes sense.

     | [[bip-0375.mediawiki|375]]
     | Applications
     | Sending Silent Payments with PSBTs
    -| Andrew Toth, Ava Chow, josibake, macgyver
    +| Andrew Toth, Ava Chow, macgyver, josibake
     | Specification
     | Draft
     |-
    
    $ ./scripts/diffcheck.sh                              
    --- scripts/diffcheck.expected	2026-11-01 15:51:21
    +++ /var/folders/bz/mn3hr6td37bczwp7j89frs4w0000gn/T/tmp.7GxoGhxTOS/after.diff	2026-11-09 13:37:54
    +< | Andrew Toth, Ava Chow, macgyver, josibake
    +> | Andrew Toth, Ava Chow, josibake, macgyver
    
  10. in scripts/buildtable.pl:185 in 7bf26a7109
     186 | -				$authors .= ", $deputyname";
     187 | +			if (defined $owners) {
     188 | +				$owners .= ", $deputyname";
     189 |  			} else {
     190 | -				$authors = $deputyname;
     191 | +				$owners = $deputyname;
    


    murchandamus commented at 11:30 PM on November 9, 2026:

    No action necessary: I was briefly wondering if $owners can even be empty here, given that the Authors header is required. I came to the conclusion that it could be, if Deputies were listed before Authors (which would then later fail on the order check). So, this should stay as is.

  11. murchandamus approved
  12. murchandamus commented at 11:31 PM on November 9, 2026: member

    ACK 7bf26a7109c5d54aa34d962be6227fbc22fb566d

  13. murchandamus added the label Proposed BIP modification on Nov 9, 2026
  14. murchandamus added the label CI on Nov 9, 2026
  15. murchandamus merged this on Nov 9, 2026
  16. murchandamus closed this on Nov 9, 2026

  17. TwistedCrafts commented at 12:57 AM on November 10, 2026: none
  18. jonatack deleted the branch on Nov 10, 2026

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bips. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-11-14 09:10 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me