Your First Feature
Take a small change from a request to a reviewed pull request with CodeLantern.
Start with a small change whose result you can check, such as adding a search box to a page. CodeLantern's workflow takes it from a request through planning, implementation, and review.
Before you begin
- An admin has configured the repository in the portal. See Admin Setup.
- You have completed Developer Setup, including your personal provider connections and plugin setup.
- The repository has been initialized with
/cl-dev:cl-init. This happens once per repository, not for each developer or feature. See Initialize the repository. - Ideally, the knowledge base has been prepared with
/cl-dev:discoverand/cl-dev:extract, so the skills start with context about your project. See Prepare the knowledge base.
If you are returning to an existing work item, use /cl-dev:set-context to resume it instead of creating another issue.
Step 1: Describe the change
Run this in your coding agent from the repository:
/cl-dev:spec add a search box to the docs site that filters pages by titleAnswer the questions about who needs the change, the problem, and the expected result. Review the proposed issue and its acceptance criteria, the conditions that show the change is complete. Once you agree to the draft, the skill creates an issue in the repository's configured project-management provider.
Step 2: Claim and plan the work
Run /cl-dev:claim-issue and identify the issue. It assigns the work to you, creates a feature branch, and opens a draft pull request.
Next, run /cl-dev:create-impl-plan. Review the proposed tasks and checks before publishing the plan. For larger or riskier changes, the skill may suggest /cl-dev:design-solution first.
Approve the plan with /cl-dev:approve-plan, or run /cl-dev:implement to approve it and begin work together.
Step 3: Build and capture what you learned
/cl-dev:implement works through the plan in phases. Each phase runs quality checks and updates the draft pull request. Resolve any reported blockers before continuing.
After implementation, run /cl-dev:consolidate to save useful learnings to the project's knowledge base. Then run /cl-dev:finalize to prepare the pull request description and mark it ready for review.
Step 4: Review and merge
Run /cl-dev:review-code to check the changes against the acceptance criteria, tests, and project conventions. Address any findings, confirm the required checks pass, and complete your team's review process before merging through your source-control provider.
Your completed task has an issue describing the outcome, a plan and recorded checks, and a reviewed pull request containing the change.
If you get stuck
For missing authorization or provider permissions, follow Integrations. For an incomplete repository configuration, ask an admin to check repository readiness. If your session ends, start a new one and use /cl-dev:set-context to resume the same work.
Planning and implementation can also run through the optional cloud agent on GitHub repositories, using /cl-dev:handoff. Keep interactive interviews and design work local.
Where to go next
Developer Setup
Join your organization, connect your accounts, install the CLI, prepare your coding agent, and give CodeLantern context about your repository.
Core Concepts
The mental model behind CodeLantern: the workflow your team runs, the knowledge base it reads and writes, and how it all fits together.