[BTC-dev] UPDATED v0.0.2: Creating, Naming, and Submitting a Patch

[Shane Kinney]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

    ..::[ The Bitcoin Foundation: Creating, Naming And Submitting A Patch ]::..

        [                   Date: 2014.11.21                              ]
        [                Version: 0.0.2                                   ]
        [                 Author: mod6 [R.01]                             ]

0x00] Purpose: To maintain consistency and provide clarification in naming and
      numerical ordering of patches to the Bitcoin reference implementation.

0x01] Creating the Patch:

      When creating the patch, ensure that you have already pruned the codebase
      in accordance with asciilifeform's [R.02] Manifest file and applied all of
      the published patches from The Bitcoin Foundation.  You may find a list
      of all published patches here: [R.03].  For a guide to this process see
      The Bitcoin Foundation document ``Building with Patch Files'' [R.04].

      With all of the patches from The Bitcoin Foundation applied, follow these
      next steps to copy over the patched source so you can make the changes for
      your patch and then output the diff of the changes.

      cp -pr bitcoin-bitcoin-a8def6b a && cp -pr bitcoin-bitcoin-a8def6b b

      Now that you have the patched source base copied into ``a'' and ``b'':

      cd b

      Now you should make your changes to the code as necessary.

0x02] Naming and Numbering the Patch:

      [ NOTE ]:
          This document supersedes the previously published announcement about
          how to properly name your patch.  The previously described
          nomenclature was lacking a numbering scheme; this is important as
          all patches are required to be applied in specific order.

      Once the code changes are complete, create a diff of the changes:

      diff -uNr a b > \
      bitcoin-v<MAJ_MIN_MAINT>-<succinct_patchname>.<patch_number>.patch

      For Example:
      diff -uNr a b > \
      bitcoin-v0_5_3-test_patch.5.patch

0x03] Signing the Patch:

      The Bitcoin Foundation requires that you use a GnuPG Detached Signature
      to sign your patch file.

      Sign the patch file as follows:

      gpg --armor --output <your_patch_file>.sig --detach-sig <your_patch_file>

      For Example:
      gpg --armor --output bitcoin-v0_5_3-test_patch.5.patch.sig \
      --detach-sig bitcoin-v0_5_3-test_patch.5.patch

0x04] Submitting the Patch

      To send your patch(s) to the BTC-Dev [R.05] mailing list, first you need
      to create a GPG signed message and then attach your patch file(s) and
      your detached signature files to the email.

      [ NOTE ]:
      The BTC-Dev mailing list will not relay any messages unless they are
      signed by GPG keys associated with #bitcoin-otc WoT [R.06] identities
      with positive trust from the ``assbot'' entity in the WoT.

      The BTC-dev [R.05] mailing list won't broadcast messages that aren't GPG
      signed with a GPG key in the #bitcoin-otc WoT [R.06].  Your submission
      must be signed with a key that has positive ratings with respect
      to `assbot`'s L2 [R.07].

      Read more about this here: [R.08].

[ References ]:

  [R.01] 027A 8D7C 0FB8 A166 4372 0F40 7217 05A8 B71E ADAF
  [R.02] 1721 5D11 8B72 3950 7FAF ED98 B982 28A0 01AB FFC7
  [R.03] http://thebitcoin.foundation
  [R.04] http://thebitcoin.foundation/ml/btc-dev/2014-December/000015.html
  [R.05] http://thebitcoin.foundation/mailman/listinfo/btc-dev
  [R.06] http://bitcoin-otc.com/trust.php
  [R.07] http://wiki.bitcoin-otc.com/wiki/OTC_Rating_System
  [R.08] http://qntra.net/2014/11/introducing-a-new-bitcoin-foundation/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.13 (FreeBSD)

iQIcBAEBCgAGBQJUk6CCAAoJEHIXBai3Hq2vfQsQAKFBGvP9JhkM1PkWtUo3IuwI
7EUs3IN7Te4PZNQI8lGBryg/5e3xU62+HcrurqC5S6enRhuOlWp00zGHbrt5xZiK
gcojO3yOzzSJX2UIUIC6nkvPhfYKT5lEXz+STPk8REARqZwDvxGJYM6uh3HdyLKR
DWa4sawPmGDnPhCXbj61/LFDwWQsk28+aTmibtPDIeODF3wuRTG6fQG4ul0Jbf94
c1uY3ERvGtRs8Mvn7858Oh0DcKNXzlXiIl8UnkmUat4yVoTZyiUqEblAFuxuqUDl
X1RlvoOBhgMRknarF5xbyVuXJULJG2WUG9rbnNBK4CV04xD0iU4m5w3yd3cG+lhN
tmc8BwaZzqKqwzTWYoWnesDdwiW5IpcufpYKDsBLKA7pHMrmLljKg6YjtgehyGXy
ALeAzz7SJ56myWl0nJYNaLQs10twGyOrtFzPt0Z7B6FJXDeBbll5h4qQvKlgHYGd
Cgc7lb63Gs6/rq+ou1cTiEeL0u2kgzwJr38s/HWz1WRh4yCA7uC6H93x4AGaRK3D
SAK1aaYloPIYl288cSTDepktkzWN6vDUThhFyzVkl1sLuYpKcHeM1BWLf+97pmCi
/lmupoYdN0od6uLeIbaBg7fv68/BcmHpKRFfvibL7YU4WG9zghdJ2DwYaIgH0Y4s
KB8ZlQtDctM67CIzLC9m
=Dt7o
-----END PGP SIGNATURE-----