Skip to content

Commit 41fb84e

Browse files
realpascalbotjetrealpascalbotjet
authored andcommitted
chore(boost): align guidelines and skill format
1 parent 242cf11 commit 41fb84e

3 files changed

Lines changed: 36 additions & 44 deletions

File tree

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
1-
{{--
2-
Laravel Boost guidelines (repository core)
1+
{{-- Laravel Eloquent Scope as Select Guidelines for AI Code Assistants --}}
2+
{{-- Source: https://github.com/protonemedia/laravel-eloquent-scope-as-select --}}
3+
{{-- License: MIT | (c) ProtoneMedia --}}
34

4-
This file intentionally stays small: it links this repository to its package-specific Boost skill.
5-
--}}
5+
## Laravel Eloquent Scope as Select
66

7-
<section>
8-
<h2>Repository development skill</h2>
9-
10-
<p>
11-
When working on this repository, activate the <code>laravel-eloquent-scope-as-select-development</code> skill.
12-
It contains package-specific conventions, testing notes, and common pitfalls.
13-
</p>
14-
</section>
7+
- Expose Eloquent scopes as selectable query constraints.
8+
- Always activate the `laravel-eloquent-scope-as-select-development` skill when making package-specific changes.
Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
# laravel-eloquent-scope-as-select-development
1+
---
2+
name: laravel-eloquent-scope-as-select-development
3+
description: Development guidance for `protonemedia/laravel-eloquent-scope-as-select` (Expose Eloquent scopes as selectable query constraints.).
4+
license: MIT
5+
metadata:
6+
author: ProtoneMedia
7+
source: https://github.com/protonemedia/laravel-eloquent-scope-as-select
8+
---
29

3-
## When to activate
4-
- You are modifying code in **laravel-eloquent-scope-as-select**.
5-
- You are reviewing/triaging issues or PRs for **laravel-eloquent-scope-as-select**.
6-
- You are preparing a release (version bump, tag, changelog).
10+
# Laravel Eloquent Scope as Select Development
711

8-
## Aim
9-
Ship safe improvements while preserving the documented public API and keeping the test suite green.
12+
## Overview
13+
Use this skill when changing package code, docs, tests, or release tooling for `protonemedia/laravel-eloquent-scope-as-select`.
1014

11-
## Do
12-
- Keep PRs small and focused.
13-
- Treat documented behavior (README) as the supported contract.
14-
- Add or update tests when behavior changes.
15-
- Prefer Laravel conventions (container bindings, facades, config publishing, events).
15+
## When to Activate
16+
- You are modifying code in this repository.
17+
- You are reviewing/triaging issues or PRs for this package.
18+
- You are preparing a release (version bump, tag, changelog).
1619

17-
## Don’t
18-
- Introduce breaking changes without clearly documenting them.
19-
- Add new runtime dependencies without strong justification.
20-
- Bake in app-specific assumptions; keep the package reusable.
20+
## Workflow
21+
1. Skim the README / docs to confirm the public contract.
22+
2. Read for common patterns and pitfalls.
23+
3. Keep changes small, add/update tests when behavior changes, and avoid breaking API changes.
2124

22-
## Quick workflow
23-
- Install dependencies: `composer install`
24-
- Run tests: `composer test` (or the repository’s configured test command)
25+
## References
26+
-
Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
1-
# laravel-eloquent-scope-as-select development guide
1+
# Laravel Eloquent Scope as Select Reference
22

3-
For full documentation, see the README: https://github.com/protonemedia/laravel-eloquent-scope-as-select#readme
3+
Complete reference for `protonemedia/laravel-eloquent-scope-as-select`. Full documentation: https://github.com/protonemedia/laravel-eloquent-scope-as-select#readme
44

5-
## At a glance
6-
Allows re-using Eloquent query scopes/constraints by adding them as a **subquery/select**.
5+
## Start Here
6+
- README / docs: https://github.com/protonemedia/laravel-eloquent-scope-as-select#readme
77

8-
## Local setup
9-
- Install dependencies: `composer install`
10-
- Keep the dev loop package-focused (avoid adding app-only scaffolding).
8+
## Notes for AI Assistants
9+
- Treat the README as the source of truth for the supported public API.
10+
- Keep changes backward-compatible unless the change is explicitly a breaking change.
1111

1212
## Testing
13-
- Run: `composer test` (preferred) or the repository’s configured test runner.
14-
- Add regression tests for bug fixes.
13+
- Run the repository test command (see README / composer scripts).
1514

16-
## Notes & conventions
17-
- Subquery correctness is essential (bindings, aliases, SQL portability).
18-
- Add tests for complex scopes (whereHas, joins, bindings).
19-
- Prefer database-agnostic SQL when possible.
15+
For detailed usage examples and the full API surface, refer to the README.

0 commit comments

Comments
 (0)