Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (51 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

78 lines (51 loc) · 2.07 KB
Raw

Contributing

Contributions, ideas, bug reports, and improvements are welcome.

Full documentation: https://php-n8n.com

Before submitting large changes, please open an issue or discussion so the direction can be agreed on early.

Project Direction

php-n8n/client is a lightweight, PSR-compliant PHP client for triggering and tracking n8n webhook executions.

The core package should remain:

  • Framework agnostic
  • PSR-first
  • Immutable by design
  • Explicit rather than magical
  • Small and composable
  • Focused on webhook execution, execution tracking, and transport abstractions

The package intentionally does not aim to become a full n8n SDK.

Development

Install dependencies:

composer install

Run the full project checks:

composer check

This runs Composer validation, PHPUnit, PSR-12 checks, and PHPStan.

CI/CD

CI runs on pushes and pull requests. After the full CI and coverage jobs pass on main, the workflow dispatches the client-ci-passed repository event using saedyousef/repository-dispatch.

The dispatch job requires a REPOSITORY_DISPATCH_TOKEN secret with repository access. The receiver workflow listens for client-ci-passed, checks out the tested commit, validates Composer metadata, builds a Composer archive, and uploads it as a workflow artifact.

Pull Requests

When contributing code:

  • Follow the existing coding standards
  • Include tests when applicable
  • Keep changes focused and minimal
  • Maintain PSR compliance
  • Avoid framework-specific dependencies in the core client
  • Update documentation when behavior or public APIs change

Bug Reports

For bug reports, please include:

  • PHP version
  • Package version
  • Relevant PSR-7, PSR-17, and PSR-18 implementations
  • Reproduction steps
  • Expected behavior
  • Actual behavior

Feature Requests

For feature requests, please explain:

  • The problem being solved
  • The proposed API or design
  • Potential tradeoffs or alternatives
  • Whether the feature belongs in the core package or a separate ecosystem package

Discussion and feedback are welcome through GitHub Issues and Discussions.