-
-
Notifications
You must be signed in to change notification settings - Fork 825
docs: configure agent skills #14742
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
hardfist
wants to merge
4
commits into
main
Choose a base branch
from
codex/configure-agent-skills
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+231
−0
Open
docs: configure agent skills #14742
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| # Rspack | ||
|
|
||
| Rspack is the JavaScript bundling context for this repository. Use this glossary when discussing bundling behavior, webpack compatibility, extension points, and generated output. | ||
|
|
||
| ## Language | ||
|
|
||
| ### Product and compatibility | ||
|
|
||
| **Rspack**: | ||
| The JavaScript bundler maintained by this repository. Its product promise is high-performance bundling with strong webpack ecosystem compatibility. | ||
| _Avoid_: rspack, Rspack bundler | ||
|
|
||
| **Rstack**: | ||
| The broader JavaScript toolchain ecosystem centered on Rspack, including related tools such as Rsbuild and Rslib. | ||
| _Avoid_: Rspack ecosystem, RsPack stack | ||
|
|
||
| **Webpack compatibility**: | ||
| The property that an API, option, plugin, loader, runtime behavior, or output behavior matches webpack closely enough for existing webpack users and integrations to rely on it. | ||
| _Avoid_: Webpack parity, compatible enough | ||
|
|
||
| ### Compilation model | ||
|
|
||
| **Compiler**: | ||
| The long-lived orchestrator for configuration, plugin registration, file systems, watch mode, and creation of compilations. | ||
| _Avoid_: Builder, runner | ||
|
|
||
| **Compilation**: | ||
| A single build instance that owns module processing, graph construction, optimization, chunk creation, and asset generation. | ||
| _Avoid_: Build, compiler run | ||
|
|
||
| **Entry point**: | ||
| A configured starting point from which Rspack begins discovering modules for a compilation. | ||
| _Avoid_: Entry file, app root | ||
|
|
||
| **Make phase**: | ||
| The compilation phase where modules are built and the module graph is constructed. | ||
| _Avoid_: Graph build, dependency collection | ||
|
|
||
| **Seal phase**: | ||
| The compilation phase where no more modules are added and the compilation is finalized for optimization and output planning. | ||
| _Avoid_: Finalize phase, close phase | ||
|
|
||
| **Emit phase**: | ||
| The compilation phase where generated assets are written to the output file system. | ||
| _Avoid_: Write phase, output phase | ||
|
|
||
| ### Module graph | ||
|
|
||
| **Module**: | ||
| A source or generated unit that Rspack can parse, transform, connect to other modules, and include in generated output. | ||
| _Avoid_: File, script | ||
|
|
||
| **Normal module**: | ||
| A regular JavaScript, TypeScript, CSS, or asset module processed through the normal module pipeline. | ||
| _Avoid_: Regular module, source module | ||
|
|
||
| **Context module**: | ||
| A module created to represent a dynamic require context, such as a directory pattern discovered from `require.context`. | ||
| _Avoid_: Dynamic module, directory module | ||
|
|
||
| **External module**: | ||
| A module reference that Rspack leaves outside the bundle and expects the runtime environment to provide. | ||
| _Avoid_: Excluded module, CDN module | ||
|
|
||
| **Runtime module**: | ||
| A generated module that provides bundler runtime behavior such as module loading, chunk loading, or Hot Module Replacement support. | ||
| _Avoid_: Runtime code, bootstrap code | ||
|
|
||
| **Dependency**: | ||
| A relationship discovered from an entry point or module to another requested resource. | ||
| _Avoid_: Edge, import | ||
|
|
||
| **Module graph connection**: | ||
| The resolved link in the module graph that connects a dependency from its origin to the module it resolves to. | ||
| _Avoid_: Dependency edge, resolved dependency | ||
|
|
||
| **Module graph**: | ||
| The graph of modules, dependencies, and module graph connections built during compilation. | ||
| _Avoid_: Dependency graph, import graph | ||
|
|
||
| ### Chunk and asset model | ||
|
|
||
| **Chunk**: | ||
| A group of modules that Rspack plans and emits together as part of the output loading strategy. | ||
| _Avoid_: Bundle, output file | ||
|
|
||
| **Entry chunk**: | ||
| A chunk generated from an entry point and loaded as part of starting the application. | ||
| _Avoid_: Main bundle, entry bundle | ||
|
|
||
| **Async chunk**: | ||
| A chunk loaded on demand, commonly produced by dynamic import or code splitting. | ||
| _Avoid_: Lazy bundle, split bundle | ||
|
|
||
| **Runtime chunk**: | ||
| A chunk that carries runtime modules separately from application modules. | ||
| _Avoid_: Runtime bundle, bootstrap bundle | ||
|
|
||
| **Chunk graph**: | ||
| The graph that records chunk relationships and which modules belong to which chunks. | ||
| _Avoid_: Bundle graph, output graph | ||
|
|
||
| **Asset**: | ||
| An output artifact produced by compilation, such as JavaScript, CSS, images, source maps, or generated HTML. | ||
| _Avoid_: File, emitted file | ||
|
|
||
| **Asset info**: | ||
| Metadata attached to an asset, such as size, related assets, or output hints. | ||
| _Avoid_: Asset metadata, file metadata | ||
|
|
||
| ### Extension model | ||
|
|
||
| **Plugin**: | ||
| An extension that hooks into the compiler or compilation lifecycle to observe or modify bundling behavior. | ||
| _Avoid_: Extension, addon | ||
|
|
||
| **Builtin plugin**: | ||
| A core plugin shipped by Rspack as part of its built-in behavior. | ||
| _Avoid_: Internal plugin, native plugin | ||
|
|
||
| **Hook**: | ||
| A named lifecycle point where plugins can tap callbacks to observe or change compiler or compilation behavior. | ||
| _Avoid_: Event, callback point | ||
|
|
||
| **Tap**: | ||
| The act of registering a plugin callback on a hook. | ||
| _Avoid_: Listener registration, callback registration | ||
|
|
||
| **Loader**: | ||
| A transform that processes a module resource before Rspack parses it and adds it to the module graph. | ||
| _Avoid_: Transformer, preprocessor | ||
|
|
||
| **Loader chain**: | ||
| The ordered sequence of loaders applied to a module resource. | ||
| _Avoid_: Loader pipeline, transform chain | ||
|
|
||
| **Loader context**: | ||
| The object exposed to a loader that provides metadata, options, dependency registration, and other loader utilities. | ||
| _Avoid_: Loader this, loader API object | ||
|
|
||
| **Pitch loader**: | ||
| A loader behavior that runs in the pitch phase before the normal loader chain executes. | ||
| _Avoid_: Pre-loader, early loader | ||
|
|
||
| ### Resolution and optimization | ||
|
|
||
| **Module resolution**: | ||
| The process of turning a module request into the concrete module or external reference used by the compilation. | ||
| _Avoid_: Path lookup, import resolution | ||
|
|
||
| **Tree shaking**: | ||
| The optimization that removes unused exports by analyzing how modules import and export values. | ||
| _Avoid_: Dead code elimination | ||
|
|
||
| **Code splitting**: | ||
| The optimization that divides code into multiple chunks to control loading and caching behavior. | ||
| _Avoid_: Bundle splitting, chunk splitting | ||
|
|
||
| **Scope hoisting**: | ||
| The optimization that concatenates compatible modules into a shared scope to reduce runtime overhead. | ||
| _Avoid_: Module concatenation | ||
|
|
||
| **Persistent cache**: | ||
| The disk-backed cache that preserves reusable compilation work across process runs. | ||
| _Avoid_: Disk cache, build cache | ||
|
|
||
| ### Development behavior | ||
|
|
||
| **Hot Module Replacement**: | ||
| Development behavior that updates affected modules in a running application without a full page reload. | ||
| _Avoid_: Hot reload, live reload | ||
|
|
||
| **Watch mode**: | ||
| Development behavior where Rspack monitors input changes and starts new compilations automatically. | ||
| _Avoid_: File watching, watch build | ||
|
|
||
| **Dev server**: | ||
| The development server that serves generated output and coordinates development features such as Hot Module Replacement. | ||
| _Avoid_: Local server, development server |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Domain docs | ||
|
|
||
| This repo uses a single-context domain docs layout. | ||
|
|
||
| Before exploring, engineering skills should read these when present: | ||
|
|
||
| - `CONTEXT.md` at the repo root | ||
| - `docs/adr/` for architectural decisions that touch the area being changed | ||
|
|
||
| If these files do not exist, proceed silently. The domain-modeling flow can create them lazily when terms or decisions are resolved. | ||
|
|
||
| When output names a domain concept, use the vocabulary from `CONTEXT.md`. If a needed concept is missing, note it as a possible gap for domain modeling. | ||
|
|
||
| If output contradicts an existing ADR, surface that conflict explicitly. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Issue tracker: GitHub | ||
|
|
||
| Issues and PRDs for this repo live as GitHub issues. Use the `gh` CLI for all operations. | ||
|
|
||
| External contributor PRs are also a triage surface. `/triage` should include open PRs whose author association is `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, or `NONE`, and should leave `OWNER`, `MEMBER`, and `COLLABORATOR` PRs alone. | ||
|
|
||
| When a skill says "publish to the issue tracker", create a GitHub issue. | ||
|
|
||
| When a skill says "fetch the relevant ticket", run `gh issue view <number> --comments`. | ||
|
|
||
| Use `gh issue` for issues and `gh pr` for PRs. GitHub shares one number space across issues and PRs, so resolve ambiguous `#<number>` references with `gh pr view <number>` first, then fall back to `gh issue view <number>`. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Triage labels | ||
|
|
||
| The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker. | ||
|
|
||
| | Label in mattpocock/skills | Label in our tracker | Meaning | | ||
| | -------------------------- | -------------------- | ---------------------------------------- | | ||
| | `needs-triage` | `pending triage` | Maintainer needs to evaluate this issue | | ||
| | `needs-info` | `need more info` | Waiting on reporter for more information | | ||
| | `ready-for-agent` | `ready-for-agent` | Fully specified, ready for an AFK agent | | ||
| | `ready-for-human` | `ready-for-human` | Requires human implementation | | ||
| | `wontfix` | `not planned` | Will not be actioned | | ||
|
|
||
| When a skill mentions a role, use the corresponding label string from this table. |
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.
Uh oh!
There was an error while loading. Please reload this page.