Add AGENTS.md#317
Merged
Merged
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
sanmai
commented
Jun 10, 2026
There was a problem hiding this comment.
Pull request overview
Adds an AGENTS.md guide intended to orient contributors/AI assistants with development workflows, architecture notes, and testing/quality expectations for the sanmai/pipeline library.
Changes:
- Introduces
AGENTS.mddescribing project purpose, core components, and key design principles. - Documents local development commands for testing, code style, static analysis, and validation.
- Summarizes the repository’s testing philosophy (coverage/mutation testing) and performance considerations.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+87
to
+88
| - `DocumentationTest` and `DocumentationMethodsTest` enforce that README and `docs/` stay in sync with the actual public API: every public method needs a README mention and header, and documented methods must exist | ||
|
|
| ### Core Components | ||
|
|
||
|
|
||
| 1. **Main Pipeline Class**: `src/Standard.php` - see main @README.md |
| - `peek()` is destructive: it eagerly consumes the first N items (as tuples, to survive duplicate keys) and leaves the rest in the pipeline. | ||
| - Callbacks for `each()`/`tap()`/`select(onReject:)` receive `($value, $key)`; an `ArgumentCountError` from arity-sensitive internal functions (e.g. `printf(...)`) is caught once and the callable permanently wrapped to single-argument form (`callWithValueKey()`). | ||
|
|
||
| 2. **Helper Functions**: @src/functions.php |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.