Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 11 additions & 20 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**IMPORTANT**: The following general instructions apply to the DevAIFlow project and MUST be followed when contributing to this codebase.

**For JIRA operations**: This project uses the `daf` tool for issue tracker integration. Always use `daf jira` commands (documented in DAF_AGENTS.md), NOT direct API calls.
**For JIRA operations**: This project uses the `daf` tool for issue tracker integration. Always use `daf jira` commands (documented in the daf-workflow skill), NOT direct API calls.

**Skills Documentation**: The skills (CLI command documentation) are located in the **`devflow/cli_skills/`** directory in the repository.

Expand Down Expand Up @@ -211,22 +211,22 @@ When creating pull requests, the `Assisted-by: <name of code assistant>` field i

### DevAIFlow (daf tool)

**IMPORTANT**: For instructions on using the `daf` tool (DevAIFlow) for JIRA operations, session management, and workflows, see [DAF_AGENTS.md](DAF_AGENTS.md).
**IMPORTANT**: For instructions on using the `daf` tool (DevAIFlow) for JIRA operations, session management, and workflows, see the **daf-workflow skill**.

The DAF_AGENTS.md file is automatically loaded when you open sessions via `daf open` and contains:
The daf-workflow skill is automatically loaded when you open sessions and contains:
- Complete `daf jira` command reference
- Session management workflows
- JIRA integration best practices
- Issue tracker integration (JIRA, GitHub Issues, GitLab Issues)
- Configuration and troubleshooting

**Quick reference:**
- View JIRA tickets: `daf jira view PROJ-12345`
- Create JIRA issues: `daf jira create {bug|story|task} --summary "..." --parent PROJ-12345`
- Update JIRA issues: `daf jira update PROJ-12345 --description "..."`
- Session management: `daf new`, `daf open`, `daf complete`
- Configuration: `daf config edit`
- Configuration: `daf config show`

For complete documentation, refer to DAF_AGENTS.md.
For complete documentation, refer to the daf-workflow, daf-cli, and daf-jira-fields skills.

#### Safety Guards: Commands That Cannot Run Inside Claude Code

Expand Down Expand Up @@ -1526,22 +1526,13 @@ class Session(BaseModel):
- Prominent placement in JIRA Integration section of skill
- Updated "Tips for Claude Code Sessions" to lead with Wiki markup requirement
- Skills deployed to workspace via daf skills command
- Makes Wiki markup requirement more visible than DAF_AGENTS.md alone
- Makes Wiki markup requirement more visible in daf-cli skill
- Addresses issue of Claude forgetting to use JIRA Wiki markup in daf jira new sessions
- All 1229 tests pass
- ✓ Automatic version check and upgrade prompt for DAF_AGENTS.md
- Added `_get_bundled_daf_agents_content()` to read bundled file content for comparison
- Added `_check_and_upgrade_daf_agents()` to detect outdated installations and prompt for upgrade
- Modified `_validate_context_files()` to call upgrade check after finding DAF_AGENTS.md
- Content comparison detects when installed file differs from bundled version
- Prompts user: "DAF_AGENTS.md has been updated. Would you like to upgrade to the latest version?"
- User can accept (upgrade), decline (continue with current), or auto-upgrade in mock mode
- Upgrade works for both repository and workspace installations
- Non-blocking: session continues if upgrade declined or if bundled file cannot be read
- Follows same pattern as `devflow/utils/claude_commands.py` for consistency
- Comprehensive test coverage: 10 new tests covering all scenarios
- All 1556 tests pass
- Documentation updated in docs/02-installation.md with upgrade behavior explanation
- ✓ Automatic version check and upgrade prompt for DAF_AGENTS.md (DEPRECATED - replaced by daf-workflow skill in v0.2.0)
- Note: DAF_AGENTS.md was removed in favor of the daf-workflow skill (see CHANGELOG.md for migration details)
- Migration logic helps users transition from DAF_AGENTS.md to daf-workflow skill
- All workflow guidance now provided through skills (daf-workflow, daf-cli, daf-jira-fields)
- ✓ Official Windows OS support for DevAIFlow
- Fixed SIGTERM signal handling in 4 command files (new_command.py, investigate_command.py, open_command.py, jira_new_command.py)
- Windows uses SIGBREAK instead of Unix SIGTERM for graceful shutdown
Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

See [AGENTS.md](AGENTS.md) for detailed project information and coding guidelines.

**For daf tool usage instructions:** See [DAF_AGENTS.md](DAF_AGENTS.md) - This file is automatically loaded when you open sessions via `daf open` and provides comprehensive guidance on using daf commands, JIRA integration, and workflows.
**For daf tool usage instructions:** See the **daf-workflow skill** - This skill is automatically loaded when you open sessions and provides comprehensive guidance on using daf commands, issue tracker integration, and workflows.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -550,11 +550,6 @@ DevAIFlow supports the following environment variables for customization:
- Settings stored in `$DEVAIFLOW_HOME/` directory
- Personal preferences only, no team sharing

5. **Copy DAF_AGENTS.md**: Copy the `DAF_AGENTS.md` file to your project roots for automatic daf tool guidance in AI assistant sessions
- This file is automatically loaded when opening sessions
- Provides complete command reference and best practices
- Customize JIRA templates to match your organization's standards

**Configuration Files:**
- `backends/jira.json` - JIRA backend settings (URL, field mappings, transitions)
- `organization.json` - Organization-wide settings (project, field aliases)
Expand Down
1 change: 0 additions & 1 deletion devflow/cli/commands/new_command.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ def _generate_initial_prompt(
Please start by reading the following context files if they exist:
- AGENTS.md (agent-specific instructions)
- CLAUDE.md (project guidelines and standards)
- DAF_AGENTS.md (daf tool usage guide)

Also read the issue tracker ticket:
daf jira view PROJ-52470"
Expand Down
3 changes: 2 additions & 1 deletion devflow/cli_skills/daf-jira-fields/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,4 +274,5 @@ daf config show --json | jq '.jira.field_mappings'
- **daf-jira skill** - daf commands for validated JIRA operations
- **daf-jira-mcp skill** - Using MCP tools with daf intelligence
- **daf-config skill** - View configuration and field mappings
- **DAF_AGENTS.md** - JIRA templates and workflows
- **daf-workflow skill** - Workflow guidance and issue tracker integration
- **ORGANIZATION.md** - JIRA templates and organization standards
9 changes: 8 additions & 1 deletion devflow/utils/daf_agents_validation.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
"""Utility functions for validating DAF_AGENTS.md context files."""
"""Migration utilities for DAF_AGENTS.md to daf-workflow skill transition.

NOTE: DAF_AGENTS.md was deprecated in v0.2.0 and replaced by the daf-workflow skill.
This module helps users migrate by offering to delete old DAF_AGENTS.md files.

The daf-workflow skill provides all workflow guidance and is automatically loaded
by Claude Code, eliminating the need for DAF_AGENTS.md files.
"""

import importlib.resources
import shutil
Expand Down
2 changes: 1 addition & 1 deletion docs/context-templates/JIRA.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ run command

## Complete Reference

See DAF_AGENTS.md for the complete JIRA Wiki markup reference and additional JIRA integration guidelines.
See the **daf-workflow skill** and **ORGANIZATION.md** for JIRA Wiki markup reference and JIRA integration guidelines.
3 changes: 1 addition & 2 deletions docs/context-templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Context files are loaded in this order:
1. **Default files** (from project directory):
- AGENTS.md (agent-specific instructions)
- CLAUDE.md (project guidelines and standards)
- DAF_AGENTS.md (daf tool usage guide)

2. **Backend context** (from DEVAIFLOW_HOME):
- `backends/JIRA.md` - JIRA-specific integration rules
Expand Down Expand Up @@ -266,4 +265,4 @@ daf new --name test-context --goal "Test context loading"
- User-configured context: `daf config context --help`
- AGENTS.md: Project-specific agent instructions
- CLAUDE.md: Project guidelines and standards
- DAF_AGENTS.md: DevAIFlow tool usage guide
- Skills: daf-workflow, daf-cli, daf-jira-fields (auto-loaded)
14 changes: 7 additions & 7 deletions docs/developer/publishing-to-pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ unzip -l dist/devaiflow-*.whl | head -30
Verify important files are included:
- `LICENSE`
- `README.md`
- `DAF_AGENTS.md`
- All Python modules in `devflow/`
- Skills in `devflow/cli_skills/`

## Testing on TestPyPI

Expand Down Expand Up @@ -470,7 +470,7 @@ ERROR File already exists. See https://pypi.org/help/#file-name-reuse

### Missing Files in Package

**Problem:** Important files (like `LICENSE`, `DAF_AGENTS.md`) are missing from the uploaded package.
**Problem:** Important files (like `LICENSE`, skills) are missing from the uploaded package.

**Cause:** Files not included in package manifest.

Expand All @@ -480,24 +480,24 @@ ERROR File already exists. See https://pypi.org/help/#file-name-reuse
```
include LICENSE
include README.md
include DAF_AGENTS.md
recursive-include devflow/cli_skills *.md
```

2. **Verify with setup.py:**
```python
setup(
include_package_data=True,
data_files=[
("", ["DAF_AGENTS.md"]),
],
package_data={
'devflow': ['cli_skills/*/*.md'],
},
...
)
```

3. **Inspect package contents before uploading:**
```bash
tar -tzf dist/devaiflow-*.tar.gz | grep LICENSE
tar -tzf dist/devaiflow-*.tar.gz | grep DAF_AGENTS.md
tar -tzf dist/devaiflow-*.tar.gz | grep cli_skills
```

### Command Not Found: twine
Expand Down
Loading
Loading