Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (20 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.27 KB
Raw

Contributing

Thank you for improving FNET-GitHub Dispatch Workflow.

Before contributing

The repository does not yet have an approved open-source license. Do not accept outside contributions or redistribute the source until that decision is resolved.

Keep changes within the package's narrow scope: GitHub App JWT creation, installation access tokens, and GitHub Actions workflow dispatch. Framework adapters, service containers, queues, caches, generic GitHub API operations, and dotenv loading belong outside the runtime package.

Development setup

composer install
composer check

PHPUnit tests must be deterministic and must never call GitHub or depend on credentials. Use generated keys, a fixed PSR clock, and the in-memory PSR-18 fake.

Standards

  • Support PHP 8.3 and newer.
  • Add declare(strict_types=1); to PHP files.
  • Prefer final and readonly classes unless extension is intentional.
  • Keep runtime dependencies minimal and framework-neutral.
  • Never include secrets in tests, fixtures, exceptions, or logs.
  • Add tests for every behavior change.
  • Update the README and changelog for public API changes.

Use Conventional Commits such as feat(authentication): parse installation token expiration or fix(workflows): sanitize failed dispatch context.