[Info] Align ext-gmp requirement wording and refresh stale CI comments

Closed Beginner friendly
  • Is something wrong?
#167 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

A pull request for this has already been merged.

  • #190 by @s2x — merged

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
php
Domain
ci-cd, databases, documentation, testing

Research direction

Read the ext-gmp references in AGENTS.md, README.md, composer.json, and TupleCompareTest.php, then check the comment in tests/Unit/NativeClientPartialInitTest.php alongside the CI setup in ci.yml. Align the optional requirement wording in the docs and correct the comment to describe why the test installs a stub. Run the docs check and bin/lint.sh; done when both pass and the issue's three checklist items are satisfied.

Written by the indexing model from the issue text.

Description

good first issue priority:low type:docs

Description

Two small documentation inconsistencies remain:

  1. AGENTS.md:26 says the project needs ext-ffi and ext-gmp. README.md:32
    and composer.json:21-24 describe ext-gmp as optional, only for
    arbitrary-precision integers in the tuple layer, and
    tests/Unit/Tuple/TupleCompareTest.php:292 skips when GMP is missing. The
    AGENTS wording is therefore too strong; README.md:390 also omits ext-gmp
    from the prerequisites list. Pick one wording and use it in both files.
  2. tests/Unit/NativeClientPartialInitTest.php:238-240 still says "on CI the
    real libfdb_c.so is not installed". After #152/#158 the PHP 8.4 unit job
    installs the real client (ci.yml:104-110). The test still installs the stub
    deliberately, so the comment should explain that the stub keeps the lookup
    independent of whether a real library happens to be installed, not claim CI
    never has one.

Found during #137 / PR #152, #144 / PR #155 and #149 / PR #158.

Where to start

  • AGENTS.md:26, README.md:32,390, composer.json:21-24: use "ext-gmp
    (optional; required for arbitrary-precision tuple integers)" consistently.
  • tests/Unit/NativeClientPartialInitTest.php:238-240: reword the comment as
    above.

Definition of done

  • AGENTS, README and composer.json agree on ext-gmp.
  • The NativeClientPartialInitTest comment is accurate for the current CI
    matrix.
  • The docs check and bin/lint.sh are green.
Dominant language
PHP
Stars
0
Forks
0
Avg merge
8h 20m
Merged PRs (30d)
23

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from crazy-goat/fdb-php

All issues in crazy-goat/fdb-php

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.