-
Contributing to Railspike
Product instruction changes belong in this repository.
docs/railspike/CONTRIBUTING.md Railspike
-
Effort scores and continuing collection
Workflow
docs/railspike/docs/effort-estimation.md Railspike
-
Railspike Failure Modes and Recovery
Railspike is intentionally strict at the points where AI-assisted work most often becomes hard to review.
docs/railspike/docs/failure-modes.md Railspike
-
User documentation
Your project's plans belong in its own docs/plans/, outside this installed directory.
docs/railspike/docs/README.md Railspike
-
One-shot cycles
Use this workflow after reading Railspike's mode selection.
docs/railspike/docs/workflow/one_shot.md Railspike
-
Step 1: Solution Assessment (Optional)
Read this file only if the feature is complex enough to require Step 1.
docs/railspike/docs/workflow/step1_solution_assessment.md Railspike
-
Step 2: Feature Description
Open this only after receiving “Approved Step 1” (or if Step 1 was skipped).
docs/railspike/docs/workflow/step2_feature_description.md Railspike
-
Step 3: Development Plan (After)
Open only after completing Step 3 Do.
docs/railspike/docs/workflow/step3_development_plan_after.md Railspike
-
Step 3: Development Plan (Before)
Open only after the user responds "Approved Step 2."
docs/railspike/docs/workflow/step3_development_plan_before.md Railspike
-
Step 3: Development Plan (Do)
Open only after completing Step 3 Before.
docs/railspike/docs/workflow/step3_development_plan_do.md Railspike
-
Step 4: Implementation (After)
Open only after completing Step 4 Do.
docs/railspike/docs/workflow/step4_implementation_after.md Railspike
-
Step 4: Implementation (Before)
Open only after the user responds "Approved Step 3."
docs/railspike/docs/workflow/step4_implementation_before.md Railspike
-
Step 4: Implementation (Do)
Open only after completing Step 4 Before.
docs/railspike/docs/workflow/step4_implementation_do.md Railspike
-
LICENSE
docs/railspike/LICENSE Railspike
-
Railspike
Planning, documentation, development, bug fixes, test suites, and checklists can use this four-step workflow, with an optional solution assessment upfront.
docs/railspike/RAILSPIKE.md Railspike
-
Railspike installation record
Local record, not an upstream file.
docs/railspike/RAILSPIKE_SOURCE.md Railspike
-
Railspike
Railspike is a set of Markdown instructions your agent follows.
docs/railspike/README.md Railspike
-
Welcome to Railspike
Agent instructions: follow this file after inspection and successful installation.
docs/railspike/WELCOME.md Railspike