Skip to content
This repository was archived by the owner on Feb 15, 2026. It is now read-only.

Commit 2538072

Browse files
committed
refactor(*.md): unify md bold and colon formatting
1 parent a234061 commit 2538072

8 files changed

Lines changed: 74 additions & 74 deletions

File tree

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ labels: 'bug, help wanted'
88

99
### 🐛 What happened?
1010

11-
**Expected:** [What should happen]
12-
**Actual:** [What actually happened]
11+
**Expected**: [What should happen]
12+
**Actual**: [What actually happened]
1313

1414
### 🔄 Steps to Reproduce
1515

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Closes #[issue-number]
1515
1616
### 🎯 Key Features
1717

18-
- **[Feature name]:** [Description of functionality or change]
18+
- **[Feature name]**: [Description of functionality or change]
1919

2020
### 💼 Business Impact
2121

22-
- **[Impact area]:** [How this benefits users or business]
22+
- **[Impact area]**: [How this benefits users or business]
2323

2424
### 🔧 Technical Highlights
2525

26-
- **[Technical aspect]:** [Implementation details or improvements]
26+
- **[Technical aspect]**: [Implementation details or improvements]
2727

2828
---

.github/workflows/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ graph TD
1616
ORCHESTRATOR --> UPDATE_DOCS
1717
```
1818

19-
**Security:** Pinned action hashes, signed commits, sequential execution
19+
**Security**: Pinned action hashes, signed commits, sequential execution
2020

2121
## 🚀 Planned Extensions
2222

23-
- **Workflows:** `auto-update-index.yml` (Tantivy), `auto-build-and-deploy.yml` (Docker)
24-
- **Managers:** pipenv, pdm, pixi
25-
- **Features:** Conditional updates, performance monitoring
23+
- **Workflows**: `auto-update-index.yml` (Tantivy), `auto-build-and-deploy.yml` (Docker)
24+
- **Managers**: pipenv, pdm, pixi
25+
- **Features**: Conditional updates, performance monitoring
2626

2727
## 🔧 Operations
2828

29-
- **Testing:** `workflow_dispatch` on both workflows
30-
- **Monitoring:** Check Tuesday runs for upstream changes
29+
- **Testing**: `workflow_dispatch` on both workflows
30+
- **Monitoring**: Check Tuesday runs for upstream changes

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ python-dep-manager-companion-mcp-server/
5353

5454
## 🛠️ Development
5555

56-
**Transport Support:** Stdio (default) and HTTP modes following MCP standards.
56+
**Transport Support**: Stdio (default) and HTTP modes following MCP standards.
5757

58-
**Environment Variables:**
58+
**Environment Variables**:
5959

6060
- `TRANSPORT_MODE`: `stdio` or `http` (default: `stdio`)
6161
- `TRANSPORT_PORT`: HTTP server port (default: `8080`)
6262
- `TRANSPORT_HOST`: Host binding (default: `127.0.0.1`)
6363

64-
**Local Development:**
64+
**Local Development**:
6565

6666
```shell
6767
# Clone and setup
@@ -73,7 +73,7 @@ uv sync
7373
uv run python src/server.py stdio
7474
```
7575

76-
**Roadmap:** Adding support for pipenv, pdm, pixi, and additional Python package managers.
76+
**Roadmap**: Adding support for pipenv, pdm, pixi, and additional Python package managers.
7777

7878
## 📄 License
7979

prompts/prompt-commit-msg-gen.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ You are a senior software engineer creating conventional commit messages followi
88

99
### STEP 1: Repository Analysis (Machine)
1010

11-
- **Local analysis:** Run `git status`, `git diff --staged`, `git log --oneline -10`
12-
- **Remote analysis:** Check `git log origin/main..HEAD` and recent branch activity
13-
- **MCP tools:** Use available MCP tools for codebase search, file reading, project analysis
11+
- **Local analysis**: Run `git status`, `git diff --staged`, `git log --oneline -10`
12+
- **Remote analysis**: Check `git log origin/main..HEAD` and recent branch activity
13+
- **MCP tools**: Use available MCP tools for codebase search, file reading, project analysis
1414

1515
### STEP 2: Classification & Title Generation (Machine)
1616

17-
- **Change type:** Determine commit type (feat, fix, docs, style, refactor, test, chore, perf, ci, build)
18-
- **Scope:** Identify primary component (single word or hyphenated: api, auth, ui, workflow, user-auth)
19-
- **Title:** Generate imperative mood description (max 50 chars)
17+
- **Change type**: Determine commit type (feat, fix, docs, style, refactor, test, chore, perf, ci, build)
18+
- **Scope**: Identify primary component (single word or hyphenated: api, auth, ui, workflow, user-auth)
19+
- **Title**: Generate imperative mood description (max 50 chars)
2020

2121
### STEP 3: User Consultation (Human)
2222

@@ -53,9 +53,9 @@ TECHNICAL NOTES
5353

5454
## CONSTRAINTS
5555

56-
- **Title:** Max 50 characters, imperative mood ("add", "fix", "update")
57-
- **Content:** Only include sections with meaningful content, use dash bullets with no redundancy between items
58-
- **Issue linking:** Only include "closes #X" for actual issue resolution
56+
- **Title**: Max 50 characters, imperative mood ("add", "fix", "update")
57+
- **Content**: Only include sections with meaningful content, use dash bullets with no redundancy between items
58+
- **Issue linking**: Only include "closes #X" for actual issue resolution
5959

6060
## EXAMPLES
6161

prompts/prompt-issue-gen.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ You are a technical documentation specialist creating GitHub issues that communi
88

99
### STEP 1: Information Gathering (Machine)
1010

11-
- **Template discovery:** Search for bug-report.md, feature-request.md or check user-attached files
12-
- **Repository context:** Search codebase for related issues, recent changes, existing functionality
13-
- **Issue classification:** Analyze user input to determine bug report, feature request, or other type
14-
- **Content extraction:** Extract symptoms, desired functionality, technical requirements
11+
- **Template discovery**: Search for bug-report.md, feature-request.md or check user-attached files
12+
- **Repository context**: Search codebase for related issues, recent changes, existing functionality
13+
- **Issue classification**: Analyze user input to determine bug report, feature request, or other type
14+
- **Content extraction**: Extract symptoms, desired functionality, technical requirements
1515

1616
### STEP 2: User Consultation (Human + Machine)
1717

18-
- **Template selection:** If type unclear, ask user to specify (Bug Report: problems/errors, Feature Request: new functionality)
19-
- **Context clarification:** Ask for missing template requirements (Bug: reproduction steps, expected/actual behavior, environment; Feature: problem statement, solution, alternatives)
20-
- **Priority assessment:** Confirm importance level and related issues/dependencies
18+
- **Template selection**: If type unclear, ask user to specify (Bug Report: problems/errors, Feature Request: new functionality)
19+
- **Context clarification**: Ask for missing template requirements (Bug: reproduction steps, expected/actual behavior, environment; Feature: problem statement, solution, alternatives)
20+
- **Priority assessment**: Confirm importance level and related issues/dependencies
2121

2222
### STEP 3: Issue Generation (Machine)
2323

24-
- **Template compliance:** Follow discovered template structure with proper markdown formatting
25-
- **Information organization:** Structure content by template sections using dash bullets with clear, actionable details and no overlap between items
26-
- **Output delivery:** Present final issue in markdown code block with all required fields populated
24+
- **Template compliance**: Follow discovered template structure with proper markdown formatting
25+
- **Information organization**: Structure content by template sections using dash bullets with clear, actionable details and no overlap between items
26+
- **Output delivery**: Present final issue in markdown code block with all required fields populated
2727

2828
## CONSTRAINTS
2929

30-
- **Template priority:** Use bug-report.md and feature-request.md as primary templates, adapt to any discovered templates
31-
- **Content accuracy:** Preserve technical details, error messages, requirements exactly as provided
32-
- **Actionable content:** Each section contains specific information that helps maintainers address the issue
33-
- **Label compliance:** Include appropriate labels and formatting per template frontmatter
30+
- **Template priority**: Use bug-report.md and feature-request.md as primary templates, adapt to any discovered templates
31+
- **Content accuracy**: Preserve technical details, error messages, requirements exactly as provided
32+
- **Actionable content**: Each section contains specific information that helps maintainers address the issue
33+
- **Label compliance**: Include appropriate labels and formatting per template frontmatter
3434

3535
## OUTPUT FORMAT
3636

prompts/prompt-pull-request-gen.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,34 @@ You are a senior software engineer creating pull request descriptions that commu
88

99
### STEP 1: Branch Analysis (Machine)
1010

11-
- **Template discovery:** Search for pull_request_template.md or check user-attached files
12-
- **Git analysis:** Run `git log origin/main..HEAD --oneline`, `git diff origin/main...HEAD --stat`, `git show --name-only HEAD`
13-
- **Change analysis:** Use `git diff origin/main...HEAD` for code modifications and GitHub MCP tools for related issues/PRs
14-
- **Codebase context:** Search affected functionality, dependencies, and architectural patterns
11+
- **Template discovery**: Search for pull_request_template.md or check user-attached files
12+
- **Git analysis**: Run `git log origin/main..HEAD --oneline`, `git diff origin/main...HEAD --stat`, `git show --name-only HEAD`
13+
- **Change analysis**: Use `git diff origin/main...HEAD` for code modifications and GitHub MCP tools for related issues/PRs
14+
- **Codebase context**: Search affected functionality, dependencies, and architectural patterns
1515

1616
### STEP 2: User Consultation (Human + Machine)
1717

18-
- **Change confirmation:** Present detected changes summary and confirm scope/key areas
19-
- **Issue linkage:** Ask which issues this resolves and related dependencies
20-
- **Context clarification:** Request business motivation, testing approach, breaking changes, review considerations
18+
- **Change confirmation**: Present detected changes summary and confirm scope/key areas
19+
- **Issue linkage**: Ask which issues this resolves and related dependencies
20+
- **Context clarification**: Request business motivation, testing approach, breaking changes, review considerations
2121

2222
### STEP 3: PR Generation (Machine)
2323

24-
- **Template compliance:** Follow discovered template structure with proper markdown formatting
25-
- **Content organization:** Structure by template sections using dash bullets with no overlap, emphasizing business value and technical highlights
26-
- **Change categorization:** Group changes by:
27-
- **Feature area:** Use when changes are specific to particular modules, functionality, or user-facing features
28-
- **Impact level:** Apply when prioritizing by significance (critical fixes, performance improvements, minor updates)
29-
- **Architectural component:** Choose for changes affecting core elements (database schemas, APIs, system integrations)
24+
- **Template compliance**: Follow discovered template structure with proper markdown formatting
25+
- **Content organization**: Structure by template sections using dash bullets with no overlap, emphasizing business value and technical highlights
26+
- **Change categorization**: Group changes by:
27+
- **Feature area**: Use when changes are specific to particular modules, functionality, or user-facing features
28+
- **Impact level**: Apply when prioritizing by significance (critical fixes, performance improvements, minor updates)
29+
- **Architectural component**: Choose for changes affecting core elements (database schemas, APIs, system integrations)
3030
- These approaches can be combined for better clarity (e.g., feature area with impact level sub-grouping)
31-
- **Output delivery:** Present final PR description in markdown code block
31+
- **Output delivery**: Present final PR description in markdown code block
3232

3333
## CONSTRAINTS
3434

35-
- **Template priority:** Use pull_request_template.md as primary template, adapt to any discovered templates
36-
- **Analysis depth:** Analyze feature branch against main using git commands and GitHub MCP tools
37-
- **Content accuracy:** Preserve implementation details, performance impacts, architectural decisions
38-
- **Business context:** Connect technical changes to business value and user impact
35+
- **Template priority**: Use pull_request_template.md as primary template, adapt to any discovered templates
36+
- **Analysis depth**: Analyze feature branch against main using git commands and GitHub MCP tools
37+
- **Content accuracy**: Preserve implementation details, performance impacts, architectural decisions
38+
- **Business context**: Connect technical changes to business value and user impact
3939

4040
## OUTPUT FORMAT
4141

prompts/prompt-readme-gen.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,33 @@ You are a technical documentation specialist creating comprehensive README files
88

99
### STEP 1: Project Analysis (Machine)
1010

11-
- **Repository discovery:** Use readonly git commands (`git log --oneline -10`, `git branch -a`, `git ls-files`) to understand project history and structure
12-
- **Codebase analysis:** Use IDE editor/agent tools for file reading, directory traversal, and dependency analysis
13-
- **Structure mapping:** Run readonly bash commands (`find`, `ls -la`, `tree` if available) to map project architecture
14-
- **Technology detection:** Identify frameworks, languages, build tools, configuration files through file analysis
11+
- **Repository discovery**: Use readonly git commands (`git log --oneline -10`, `git branch -a`, `git ls-files`) to understand project history and structure
12+
- **Codebase analysis**: Use IDE editor/agent tools for file reading, directory traversal, and dependency analysis
13+
- **Structure mapping**: Run readonly bash commands (`find`, `ls -la`, `tree` if available) to map project architecture
14+
- **Technology detection**: Identify frameworks, languages, build tools, configuration files through file analysis
1515

1616
### STEP 2: User Consultation (Human + Machine)
1717

18-
- **Project confirmation:** Present discovered project structure and technology stack for verification
19-
- **Purpose clarification:** Ask about project goals, target audience, key features, and unique value proposition
20-
- **Context gathering:** Request deployment details, environment requirements, known limitations, future roadmap
18+
- **Project confirmation**: Present discovered project structure and technology stack for verification
19+
- **Purpose clarification**: Ask about project goals, target audience, key features, and unique value proposition
20+
- **Context gathering**: Request deployment details, environment requirements, known limitations, future roadmap
2121

2222
### STEP 3: README Generation (Machine)
2323

24-
- **Structure creation:** Generate file structure tree in plaintext code block with descriptive comments
25-
- **Content organization:** Create sections using level 2 headings with unique professional emojis, balance bullets and paragraphs to prevent both excessive bullets and oversized paragraphs
26-
- **Output delivery:** Present complete README in markdown code block ready for project root
24+
- **Structure creation**: Generate file structure tree in plaintext code block with descriptive comments
25+
- **Content organization**: Create sections using level 2 headings with unique professional emojis, balance bullets and paragraphs to prevent both excessive bullets and oversized paragraphs
26+
- **Output delivery**: Present complete README in markdown code block ready for project root
2727

2828
## CONSTRAINTS
2929

30-
- **Technology agnostic:** Work with any programming language, framework, or project type
31-
- **Analysis depth:** Use only readonly commands and tools to understand project without modifications
32-
- **Section focus:** Include only essential sections applicable to both OSS and private projects
33-
- **Emoji standards:** Use unique professional emojis for level 2 headings only, no decorative elements
34-
- **Content simplicity:** Apply KISS (Keep It Simple, Stupid) and DRY (Don't Repeat Yourself) principles for concise and maintainable content
35-
- **Content balance:** Balance bullets and paragraphs to avoid excessive bullets or oversized paragraphs
36-
- **Content uniqueness:** Ensure no content overlap or repetition between sections
37-
- **Overview brevity:** Keep overview section under 10 seconds read time with essential value proposition only
30+
- **Technology agnostic**: Work with any programming language, framework, or project type
31+
- **Analysis depth**: Use only readonly commands and tools to understand project without modifications
32+
- **Section focus**: Include only essential sections applicable to both OSS and private projects
33+
- **Emoji standards**: Use unique professional emojis for level 2 headings only, no decorative elements
34+
- **Content simplicity**: Apply KISS (Keep It Simple, Stupid) and DRY (Don't Repeat Yourself) principles for concise and maintainable content
35+
- **Content balance**: Balance bullets and paragraphs to avoid excessive bullets or oversized paragraphs
36+
- **Content uniqueness**: Ensure no content overlap or repetition between sections
37+
- **Overview brevity**: Keep overview section under 10 seconds read time with essential value proposition only
3838

3939
## OUTPUT FORMAT
4040

0 commit comments

Comments
 (0)