Skip to content

Latest commit

 

History

History
35 lines (18 loc) · 1.46 KB

File metadata and controls

35 lines (18 loc) · 1.46 KB

Contributing

Thank you for helping improve CommonPHP packages. These libraries are intended to stay small, focused, and predictable.

Scope

Contributions may include bug fixes, focused tests, documentation improvements, compatibility fixes, and small enhancements that fit the package purpose. Avoid unrelated features or broad refactors.

Code Style

Follow the style already used in the repository. Keep changes readable, typed where practical, and narrowly scoped. Do not commit generated files, vendor directories, lock files, or local tooling output unless the package explicitly requires them.

Tests

Behavior changes should include or update tests. Bug fixes should include a test that would have failed before the fix when practical.

Documentation

Public API or behavior changes should update the README or docs in the same pull request. Keep documentation concise and practical.

Bugs

When reporting bugs, include the package version or commit, PHP version, a minimal reproduction, expected behavior, and actual behavior.

Features

Feature suggestions should describe the use case, why it belongs in this package, and any compatibility concerns.

Pull Requests

Keep pull requests focused. Explain the change, include relevant tests, and call out any public API or compatibility impact.

Compatibility

CommonPHP packages may be used as building blocks. Be careful with public APIs, exception behavior, namespaces, constructor signatures, and file layout.