docs: define development workflow and AI-agent rules

Open Beginner friendly
#10 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
developer-experience, documentation

Research direction

Start by inspecting the repository root and the existing docs/ workflow guidance, including AGENTS.md if present. Create or update the root-level AI instructions and document the required development workflow; done means a new coding agent can follow the rules without relying on chat history.

Written by the indexing model from the issue text.

Description

Objective

Create explicit rules for AI-assisted development so coding agents do not repeatedly rewrite architecture or introduce uncontrolled complexity.

Required AI workflow

Before changing code:

  1. Read AGENTS.md.
  2. Read the relevant docs under docs/.
  3. Inspect the existing implementation.
  4. State the affected architectural boundary.
  5. Make the smallest coherent change.
  6. Run tests/typecheck/build.
  7. Update docs when behavior or architecture changes.

Rules

  • Do not create duplicate abstractions.
  • Do not move business logic into UI components.
  • Do not add dependencies without a documented reason.
  • Do not change architecture to solve a local bug.
  • Do not claim tests passed unless they were run.
  • Do not mark a ticket complete if acceptance criteria are not met.
  • Prefer small, reviewable changes.
  • Preserve browser portability.
  • Keep ChatGPT DOM code isolated.
  • Treat docs as part of the product architecture.

Acceptance criteria

Root-level AI instructions and the docs workflow make it possible for a new coding agent to continue work safely without relying on chat history.

Dominant language
CSS
Stars
0
Forks
0
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ChinmayOnGithub/queueit

All issues in ChinmayOnGithub/queueit

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.