janet-cli 0.3.5__tar.gz → 0.3.7__tar.gz

{janet_cli-0.3.5/janet_cli.egg-info → janet_cli-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: janet-cli
-Version: 0.3.5
+Version: 0.3.7
 Summary: CLI tool to sync Janet AI tickets to local markdown files
 Author-email: Janet AI <support@janet-ai.com>
 License: MIT
@@ -194,7 +194,7 @@ Tickets are organized in a clear hierarchy:
 
 ```
 janet-tickets/
-├── README.md                    # Context for AI agents
+├── AI_AGENT_INSTRUCTIONS.md     # Instructions for AI coding agents
 └── My Organization/
     ├── Backend/
     │   ├── BACK-1.md

{janet_cli-0.3.5 → janet_cli-0.3.7}/README.md

@@ -152,7 +152,7 @@ Tickets are organized in a clear hierarchy:
 
 ```
 janet-tickets/
-├── README.md                    # Context for AI agents
+├── AI_AGENT_INSTRUCTIONS.md     # Instructions for AI coding agents
 └── My Organization/
     ├── Backend/
     │   ├── BACK-1.md

{janet_cli-0.3.5 → janet_cli-0.3.7}/janet/__init__.py

@@ -1,3 +1,3 @@
 """Janet AI CLI - Sync tickets to local markdown files."""
 
-__version__ = "0.3.5"
+__version__ = "0.3.7"

{janet_cli-0.3.5 → janet_cli-0.3.7}/janet/sync/readme_generator.py

@@ -33,7 +33,7 @@ class ReadmeGenerator:
         sections = []
 
         # Header - addressing the AI agent directly
-        sections.append(f"# Project Tickets - {org_name}\n")
+        sections.append(f"# Instructions for AI Coding Agents - {org_name}\n")
         sections.append(
             "This directory contains project management tickets from Janet AI. "
             "Use these tickets to understand requirements, track work, and stay aligned with project goals.\n"
@@ -83,6 +83,28 @@ class ReadmeGenerator:
         sections.append("3. **Follow requirements** - Use ticket descriptions as specifications")
         sections.append("4. **Note priorities** - High/Critical tickets should be addressed first\n")
 
+        # Important notes for AI agents
+        sections.append("## ⚠️ IMPORTANT: Creating Tickets (Required Fields)\n")
+        sections.append("### Required Fields for Ticket Creation\n")
+        sections.append("**Every** ticket creation command **MUST** include:\n")
+        sections.append("1. **Title** - The ticket title (first positional argument)")
+        sections.append("2. **Project** - The project key using `--project` or `-p`")
+        sections.append("3. **Status** - A valid status using `--status` or `-s`\n")
+
+        sections.append("### Status Values Are Custom Per Project\n")
+        sections.append("Each project has custom status values (see \"Valid Statuses\" in Projects section above).\n")
+        sections.append("⚠️ **REQUIRED:** Always use a valid status from the project's \"Valid Statuses\" list.")
+        sections.append("⚠️ **If user doesn't specify a status:** Ask which status to use before running the command.")
+        sections.append("⚠️ **Never assume or guess status values** - they vary by project (e.g., \"To Do\" vs \"Backlog\" vs \"Open\").\n")
+
+        sections.append("### Example Workflow\n")
+        sections.append('**User prompt:** "Create a bug ticket in BACK for the login issue"\n')
+        sections.append("**Your response:** \"Which status should I use for the new ticket? Valid options for BACK are: To Do, In Progress, In Review, Done\"\n")
+        sections.append('**After user responds:** Run the command with the specified status:')
+        sections.append("```bash")
+        sections.append('janet ticket create "Fix login issue" -p BACK --status "To Do" --type Bug')
+        sections.append("```\n")
+
         # CLI commands for the AI - comprehensive reference
         sections.append("## CLI Commands Reference\n")
         sections.append("Use the `janet` CLI to create and update tickets.\n")
@@ -264,7 +286,7 @@ class ReadmeGenerator:
         readme_content = self.generate(org_name, projects, total_tickets, sync_time, project_statuses)
 
         # Write to root of sync directory
-        readme_path = sync_dir / "README.md"
+        readme_path = sync_dir / "AI_AGENT_INSTRUCTIONS.md"
         readme_path.write_text(readme_content, encoding="utf-8")
 
         return readme_path

{janet_cli-0.3.5 → janet_cli-0.3.7/janet_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: janet-cli
-Version: 0.3.5
+Version: 0.3.7
 Summary: CLI tool to sync Janet AI tickets to local markdown files
 Author-email: Janet AI <support@janet-ai.com>
 License: MIT
@@ -194,7 +194,7 @@ Tickets are organized in a clear hierarchy:
 
 ```
 janet-tickets/
-├── README.md                    # Context for AI agents
+├── AI_AGENT_INSTRUCTIONS.md     # Instructions for AI coding agents
 └── My Organization/
     ├── Backend/
     │   ├── BACK-1.md

{janet_cli-0.3.5 → janet_cli-0.3.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "janet-cli"
-version = "0.3.5"
+version = "0.3.7"
 description = "CLI tool to sync Janet AI tickets to local markdown files"
 readme = "README.md"
 requires-python = ">=3.8"