Skip to content

Commit 8f3680d

Browse files
crivetimihaicrivetimihai
committed
Add PULL_REQUEST_TEMPLATE
1 parent f5ac3fa commit 8f3680d

File tree

6 files changed

+123
-21
lines changed

6 files changed

+123
-21
lines changed

‎.github/ISSUE_TEMPLATE/bug-report--code-.md renamed to ‎.github/ISSUE_TEMPLATE/bug-report-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ What should have happened instead?
3838

3939
---
4040

41-
### 📓 Logs / Error Output
42-
Paste any relevant stack traces or logs here.
41+
### 📓 Logs / Error Output
42+
Paste any relevant stack traces or logs here.
4343
⚠️ **Do not paste secrets, credentials, or tokens.**
4444

4545
---
4646

47-
### 🧠 Environment Info
47+
### 🧠 Environment Info
4848
You can retrieve most of this from the `/version` endpoint.
4949

5050
| Key | Value |

‎.github/ISSUE_TEMPLATE/docs-issue.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ assignees: ''
99

1010
<!--
1111
💡 Tip: If you're suggesting a fix, include the markdown you'd use to update the doc.
12-
You can also preview changes locally by running:
12+
You can also preview changes locally by running:
1313
cd docs && make serve
1414
This helps ensure formatting and links render correctly.
1515
-->
1616

17-
### 📚 Documentation Issue Summary
17+
### 📚 Documentation Issue Summary
1818
What's wrong or missing?
1919

2020
---
2121

22-
### 📍 Location of the Problem
22+
### 📍 Location of the Problem
2323
Please link to the affected page, file, or section (if possible):
2424

25-
> Example: `docs/docs/using/agents/crewai.md` or `./README.md`
25+
> Example: `docs/docs/using/agents/crewai.md` or `./README.md`
2626
> or https://ibm.github.io/mcp-context-forge/overview/features/
2727
2828
---
@@ -37,12 +37,12 @@ Please link to the affected page, file, or section (if possible):
3737

3838
---
3939

40-
### 💡 Suggested Fix or Clarification (optional)
40+
### 💡 Suggested Fix or Clarification (optional)
4141
If you know how to fix it, describe it, paste a markdown snippet, or link a reference.
4242

4343
---
4444

45-
### 🧠 Environment (optional)
45+
### 🧠 Environment (optional)
4646
If related to platform-specific behavior (e.g. a command not working on macOS), describe that here:
4747

4848
| Key | Value |
@@ -53,5 +53,5 @@ If related to platform-specific behavior (e.g. a command not working on macOS),
5353

5454
---
5555

56-
### 🧩 Additional Notes (optional)
56+
### 🧩 Additional Notes (optional)
5757
Any screenshots, logs, or related issues?

‎.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,26 @@ Feel free to include feature requests to develop new components, MCP servers, to
1818

1919
Please select the most appropriate category:
2020

21-
- [ ] Enhancement to existing functionality
22-
- [ ] New feature or capability
23-
- [ ] New MCP-compliant server
24-
- [ ] New component or integration
25-
- [ ] Developer tooling or test improvement
21+
- [ ] Enhancement to existing functionality
22+
- [ ] New feature or capability
23+
- [ ] New MCP-compliant server
24+
- [ ] New component or integration
25+
- [ ] Developer tooling or test improvement
2626
- [ ] Packaging, automation and deployment (ex: pypi, docker, quay.io, kubernetes, terraform)
2727
- [ ] Other (please describe below)
2828

2929
### 🧭 Epic
3030

31-
**Title:** <High-level feature or capability>
32-
**Goal:** What is the big-picture objective of this feature set?
31+
**Title:** <High-level feature or capability>
32+
**Goal:** What is the big-picture objective of this feature set?
3333
**Why now:** Why is this needed? Who benefits?
3434

3535
---
3636

3737
### 🙋‍♂️ User Story 1
3838

39-
**As a:** <type of user>
40-
**I want:** <some goal>
39+
**As a:** <type of user>
40+
**I want:** <some goal>
4141
**So that:** <some reason / value>
4242

4343
#### ✅ Acceptance Criteria
@@ -57,8 +57,8 @@ Scenario: Second scenario title
5757

5858
### 🙋‍♂️ User Story 2
5959

60-
**As a:** <another type of user>
61-
**I want:** <a different goal>
60+
**As a:** <another type of user>
61+
**I want:** <a different goal>
6262
**So that:** <a different reason>
6363

6464
#### ✅ Acceptance Criteria

‎.github/PULL_REQUEST_TEMPLATE/bug_fix.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# 🐛 Bug-fix PR
2+
3+
Before opening this PR please:
4+
5+
1. `make lint` – passes `ruff`, `mypy`, `pylint`
6+
2. `make test` – all unit + integration tests green
7+
3. `make coverage` – ≥ 90 %
8+
4. `make docker docker-run-ssl` or `make podman podman-run-ssl`
9+
5. Update relevant documentation.
10+
6. Tested with sqlite and postgres + redis.
11+
7. Manual regression no longer fails. Ensure the UI and /version work correctly.
12+
13+
---
14+
15+
## 📌 Summary
16+
_What problem does this PR fix and **why**?_
17+
18+
## 🔁 Reproduction Steps
19+
_Link the issue and minimal steps to reproduce the bug._
20+
21+
## 🐞 Root Cause
22+
_What was wrong and where?_
23+
24+
## 💡 Fix Description
25+
_How did you solve it? Key design points._
26+
27+
## 🧪 Verification
28+
29+
| Check | Command | Status |
30+
|---------------------------------------|----------------------|--------|
31+
| Lint suite | `make lint` | |
32+
| Unit tests | `make test` | |
33+
| Coverage ≥ 90 % | `make coverage` | |
34+
| Manual regression no longer fails | steps / screenshots | |
35+
36+
## 📐 MCP Compliance (if relevant)
37+
- [ ] Matches current MCP spec
38+
- [ ] No breaking change to MCP clients
39+
40+
## ✅ Checklist
41+
- [ ] Code formatted (`make black isort pre-commit`)
42+
- [ ] No secrets/credentials committed

‎.github/PULL_REQUEST_TEMPLATE/docs.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# 📚 Documentation PR
2+
3+
> Run `make markdownlint spellcheck` and fix any issues.
4+
> Preview locally with `cd docs && make serve`.
5+
> Do **not** commit secrets or internal URLs.
6+
7+
---
8+
9+
## 🔗 Related Issue / Epic
10+
_Link to the doc bug or epic this PR addresses:_
11+
Closes #
12+
13+
---
14+
15+
## 📝 Summary (1–2 sentences)
16+
_What section of the docs is changing and why?_
17+
18+
---
19+
20+
## ✏️ Type of Change
21+
- [ ] Typo / formatting
22+
- [ ] Outdated or incorrect info
23+
- [ ] Missing explanation / example
24+
- [ ] Unclear instructions
25+
- [ ] New page or major rewrite
26+
- [ ] Other (describe)
27+
28+
---

‎.github/PULL_REQUEST_TEMPLATE/feature.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# ✨ Feature / Enhancement PR
2+
3+
## 🔗 Epic / Issue
4+
_Link to the epic or parent issue:_
5+
Closes #
6+
7+
---
8+
9+
## 🚀 Summary (1–2 sentences)
10+
_What does this PR add or change?_
11+
12+
---
13+
14+
## 🧪 Checks
15+
16+
- [ ] `make lint` passes
17+
- [ ] `make test` passes
18+
- [ ] CHANGELOG updated (if user-facing)
19+
20+
---
21+
22+
## 📓 Notes (optional)
23+
_Design sketch, screenshots, or extra context._
24+
25+
If the change introduces or alters an architectural decision, add or update an ADR in **`docs/docs/adr/`** and link it here._
26+
27+
```mermaid
28+
%% Example diagram – delete if not needed
29+
flowchart TD
30+
A[Client] -->|POST /completions| B(MCPGateway)
31+
B --> C[Completion Service]
32+
```

0 commit comments

Comments
 (0)