docs: add guidance on initialism capitalisation in PascalCase identifiers. #32718

pull Muniru0 wants to merge 1 commits into bitcoin:master from Muniru0:dev-notes-style-camelcase changing 1 files +5 βˆ’0
  1. Muniru0 commented at 5:57 pm on June 10, 2025: none

    Fixes #32698

    Problem Inconsistent initialization of class,function, method identifiers and structs. Spread throughout the codebase is screaming / acronym caps.

    Solution

    • Add a rule in the developer notes to use consistent camelcase naming convention.
    • A class names like JSONRPCRequest should be JsonRpcRequest.

    all existing tests pass.

  2. docs: add guidance on initialism capitalisation in PascalCase identifiers 274d90ace6
  3. DrahtBot commented at 5:57 pm on June 10, 2025: contributor

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32718.

    Reviews

    See the guideline for information on the review process. A summary of reviews will appear here.

    LLM Linter (✨ experimental)

    Possible typos and grammar issues:

    • do not to use -> do not use [extra β€œto”]
    • acronymn -> acronym [misspelling]

    drahtbot_id_4_m

  4. DrahtBot added the label Docs on Jun 10, 2025
  5. maflcko commented at 6:00 pm on June 10, 2025: member

    all existing tests pass.

    no they do not

    (There is no point in trying to claim the tests pass. Most tests are run in the CI, so anyone can see for themselves or run them themselves. If there is a test that isn’t run in CI, it would be good to mention it. However, this is just a doc change.)

  6. Muniru0 closed this on Jun 10, 2025

  7. Muniru0 deleted the branch on Jun 10, 2025
  8. Muniru0 commented at 6:18 pm on June 10, 2025: none

    all existing tests pass.

    no they do not

    (There is no point in trying to claim the tests pass. Most tests are run in the CI, so anyone can see for themselves or run them themselves. If there is a test that isn’t run in CI, it would be good to mention it. However, this is just a doc change.)

    I first push it to my branch and had no conflicts. So that is why I said the test passed before I push them here. And anyway I am currently resolving the error.


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2025-06-15 06:13 UTC

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