Skip to content

Commit 8bcaa27

Browse files
authored
docs: tidy up (#40)
1 parent 55a811e commit 8bcaa27

File tree

1 file changed

+11
-65
lines changed

1 file changed

+11
-65
lines changed

README.md

Lines changed: 11 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ coding-context [options] <task-name> [persona-name]
7777
Options:
7878
-b Automatically run the bootstrap script after generating it
7979
-m <path> Directory containing memories, or a single memory file (can be used multiple times)
80-
Defaults: AGENTS.md, .github/copilot-instructions.md, CLAUDE.md, .cursorrules,
81-
.cursor/rules/, .instructions.md, .continuerules, .prompts/memories,
80+
Defaults: AGENTS.md, .github/copilot-instructions.md, CLAUDE.md, .cursorrules,
81+
.cursor/rules/, .instructions.md, .continuerules, .prompts/memories,
8282
~/.config/prompts/memories, /var/local/prompts/memories
8383
-r <path> Directory containing personas, or a single persona file (can be used multiple times)
8484
Defaults: .prompts/personas, ~/.config/prompts/personas, /var/local/prompts/personas
@@ -227,8 +227,6 @@ Optional persona files define the role or character the AI agent should assume.
227227

228228
**Example** (`.prompts/personas/expert.md`):
229229
```markdown
230-
---
231-
---
232230
# Expert Software Engineer
233231

234232
You are an expert software engineer with deep knowledge of best practices.
@@ -459,9 +457,6 @@ The `kitproj/jira-cli` tool allows agents to interact with Jira issues programma
459457
**Step 1: Create a memory file with Jira context** (`.prompts/memories/jira.md`)
460458

461459
```markdown
462-
---
463-
tools: jira
464-
---
465460
# Jira Integration
466461

467462
This project uses Jira for issue tracking. The `jira` CLI tool is available for interacting with issues.
@@ -487,24 +482,11 @@ The Jira CLI is configured with:
487482
#!/bin/bash
488483
set -euo pipefail
489484

490-
# Install jira-cli if not already installed
491-
if ! command -v jira &> /dev/null; then
492-
echo "Installing jira-cli..."
493-
494-
# Download and install the latest version
495-
VERSION="v0.1.0" # Update to the latest version
496-
BINARY_URL="https://github.com/kitproj/jira-cli/releases/download/${VERSION}/jira-cli_${VERSION}_linux_amd64"
497-
498-
sudo curl -fsSL -o /usr/local/bin/jira "$BINARY_URL"
499-
sudo chmod +x /usr/local/bin/jira
500-
501-
echo "jira-cli installed successfully"
502-
else
503-
echo "jira-cli is already installed"
504-
fi
485+
VERSION="v0.1.0" # Update to the latest version
486+
BINARY_URL="https://github.com/kitproj/jira-cli/releases/download/${VERSION}/jira-cli_${VERSION}_linux_amd64"
505487

506-
# Verify installation
507-
jira --version
488+
sudo curl -fsSL -o /usr/local/bin/jira "$BINARY_URL"
489+
sudo chmod +x /usr/local/bin/jira
508490
```
509491

510492
**Step 3: Make the bootstrap script executable**
@@ -517,10 +499,7 @@ chmod +x .prompts/memories/jira-bootstrap
517499

518500
```bash
519501
# The bootstrap will automatically run when you generate context
520-
coding-context -p storyId="PROJ-123" implement-jira-story
521-
522-
# This creates ./bootstrap which installs jira-cli when executed
523-
./bootstrap
502+
coding-context -b -p storyId="PROJ-123" implement-jira-story
524503
```
525504

526505
Now when an agent starts work, the bootstrap script will ensure `jira-cli` is installed and ready to use!
@@ -532,9 +511,6 @@ The `kitproj/slack-cli` tool allows agents to send notifications and interact wi
532511
**Step 1: Create a memory file with Slack context** (`.prompts/memories/slack.md`)
533512

534513
```markdown
535-
---
536-
tools: slack
537-
---
538514
# Slack Integration
539515

540516
This project uses Slack for team communication. The `slack` CLI tool is available for sending messages and notifications.
@@ -567,24 +543,11 @@ The Slack CLI requires:
567543
#!/bin/bash
568544
set -euo pipefail
569545

570-
# Install slack-cli if not already installed
571-
if ! command -v slack &> /dev/null; then
572-
echo "Installing slack-cli..."
573-
574-
# Download and install the latest version
575-
VERSION="v0.1.0" # Update to the latest version
576-
BINARY_URL="https://github.com/kitproj/slack-cli/releases/download/${VERSION}/slack-cli_${VERSION}_linux_amd64"
577-
578-
sudo curl -fsSL -o /usr/local/bin/slack "$BINARY_URL"
579-
sudo chmod +x /usr/local/bin/slack
580-
581-
echo "slack-cli installed successfully"
582-
else
583-
echo "slack-cli is already installed"
584-
fi
546+
VERSION="v0.1.0" # Update to the latest version
547+
BINARY_URL="https://github.com/kitproj/slack-cli/releases/download/${VERSION}/slack-cli_${VERSION}_linux_amd64"
585548

586-
# Verify installation
587-
slack --version
549+
sudo curl -fsSL -o /usr/local/bin/slack "$BINARY_URL"
550+
sudo chmod +x /usr/local/bin/slack
588551
```
589552

590553
**Step 3: Make the bootstrap script executable**
@@ -680,8 +643,6 @@ Here are some practical task templates for common development workflows:
680643

681644
```bash
682645
cat > .prompts/tasks/implement-jira-story.md << 'EOF'
683-
---
684-
---
685646
# Implement Jira Story: ${storyId}
686647
687648
## Story Details
@@ -738,8 +699,6 @@ coding-context -p storyId="PROJ-123" implement-jira-story
738699

739700
```bash
740701
cat > .prompts/tasks/triage-jira-bug.md << 'EOF'
741-
---
742-
---
743702
# Triage Jira Bug: ${bugId}
744703
745704
## Get Bug Details
@@ -794,8 +753,6 @@ coding-context -p bugId="PROJ-456" triage-jira-bug
794753

795754
```bash
796755
cat > .prompts/tasks/respond-to-jira-comment.md << 'EOF'
797-
---
798-
---
799756
# Respond to Jira Comment: ${issueId}
800757
801758
## Get Issue and Comments
@@ -845,8 +802,6 @@ coding-context -p issueId="PROJ-789" respond-to-jira-comment
845802

846803
```bash
847804
cat > .prompts/tasks/notify-build-status.md << 'EOF'
848-
---
849-
---
850805
# Notify Build Status: ${buildStatus}
851806
852807
## Task
@@ -909,8 +864,6 @@ coding-context -p buildStatus="SUCCESS" -p branch="main" -p commit="abc123" -p b
909864

910865
```bash
911866
cat > .prompts/tasks/notify-deployment.md << 'EOF'
912-
---
913-
---
914867
# Notify Deployment: ${environment}
915868
916869
## Task
@@ -974,8 +927,6 @@ coding-context -p environment="production" -p version="v2.1.0" -p deployer="depl
974927

975928
```bash
976929
cat > .prompts/tasks/review-pull-request.md << 'EOF'
977-
---
978-
---
979930
# Review Pull Request: ${prNumber}
980931
981932
## PR Details
@@ -1028,8 +979,6 @@ coding-context -p prNumber="42" -p author="Jane" -p title="Add feature X" review
1028979

1029980
```bash
1030981
cat > .prompts/tasks/respond-to-pull-request-comment.md << 'EOF'
1031-
---
1032-
---
1033982
# Respond to Pull Request Comment
1034983
1035984
## PR Details
@@ -1074,8 +1023,6 @@ coding-context -p prNumber="42" -p reviewer="Bob" -p file="main.go" -p comment="
10741023

10751024
```bash
10761025
cat > .prompts/tasks/fix-failing-check.md << 'EOF'
1077-
---
1078-
---
10791026
# Fix Failing Check: ${checkName}
10801027
10811028
## Check Details
@@ -1205,4 +1152,3 @@ coding-context -p myvar="value" my-task
12051152
```bash
12061153
chmod +x bootstrap
12071154
```
1208-

0 commit comments

Comments
 (0)