Contributing

Contributing

Bug reports, documentation improvements and pull requests are welcome.

Development setup

git clone https://github.com/TeemoCell/SteamWebAPI.git
cd SteamWebAPI
composer install

Before changing code

• search existing issues and pull requests;
• keep changes focused;
• preserve the public namespace TeemoCell\SteamWebApi;
• add or update tests for behavior changes;
• document new public methods.

Validation

composer validate --strict --no-check-publish
composer audit --locked
php vendor/bin/rector process --dry-run
php vendor/bin/phpunit --filter "AppListTest|ClientConstructionTest|CurrentApiEndpointsTest|UserStatsResponseTest|LaravelClientBindingTest"

The complete test suite contains live Steam calls. Never include a real API key in commits or test output.

Pull requests

Describe:

• what changed;
• why it is needed;
• compatibility impact;
• which checks were run;
• whether a Steam key, publisher key or specific profile visibility was required.

Documentation

The GitHub Wiki is a separate repository:

git clone https://github.com/TeemoCell/SteamWebAPI.wiki.git

Update _Sidebar.md when adding a page and verify every relative Wiki link before pushing.