Contributing

Develop, test, and preview documentation changes locally.

Start from an open GitHub issue and keep each change scoped to one verifiable outcome.

SDK development

git clone https://github.com/alex-jordan547/proclubs-sdk.git
cd proclubs-sdk
npm install
npm run check

The default test suite must remain offline and deterministic. Test through the public SDK interface and inject a transport at the network boundary.

Compatibility checks

To verify structural compatibility and contract drift against live EA FC endpoints (opt-in and low frequency):

npm run check:compatibility

To choose a club that exists on the target platform, pass a search query:

TARGET_PLATFORM=nx \
COMPATIBILITY_SEARCH_QUERY="<club name on that platform>" \
npm run check:compatibility

Probes run sequentially, stop at the first access control error, and produce a sanitized drift report without logging sensitive identifiers or raw response bodies. Unknown EA enum values are reported as unknown_value while remaining compatible; structural changes, rejected payloads, and empty responses require review.

Documentation preview

From the repository root, run:

npx mint dev

Mintlify serves the local preview at http://localhost:3000 by default.

Validate all pages and navigation before opening a pull request:

npx mint validate

Data safety

Never commit:

• cookies, tokens, or credentials;
• complete live response dumps;
• personal data;
• fixtures that have not been manually sanitized.

Live compatibility probes must remain explicit, sequential, and low volume. They must not become required CI checks.

Project scope

proclubs-sdk is a small Node.js library. Contributions should not add a hosted relay, database, cache, browser automation, authentication flow, or telemetry to the core package.

Open the repository

Browse issues, source code, and pull requests on GitHub.