Skip to content
Draft
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
90 changes: 90 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
name: Bug Report
about: Report a bug or issue in ProSe
title: "[BUG] "
labels: bug
assignees: ""
---

## 🐛 Bug Description

A clear and concise description of what the bug is.

> Example: "Evidence validator crashes when timeline.csv is missing the Evidence_IDs column."

---

## 📂 Area Affected

Which part of the system is impacted?

- [ ] Engine / core
- [ ] Agents (e.g. evidence validator, timeline builder)
- [ ] file_organizer / PSFO tools
- [ ] Tests
- [ ] Docs
- [ ] Other (describe):

---

## 📋 Steps to Reproduce

1. Go to "..."
2. Run command / action: `...`
3. Using data / sample files: `...`
4. See error: `...`

> Include exact commands if possible.

---

## ✅ Expected Behavior

What you **expected** to happen.

---

## ❌ Actual Behavior

What **actually** happened.

- Error messages (copy/paste if possible):
- Did it crash, hang, or produce wrong output?

---

## 🖼️ Screenshots (Optional)

If applicable, add screenshots or logs to help explain the problem.

> ⚠️ **Do not** include real case documents, real names, or unredacted legal files.

---

## 🌍 Environment

- OS: [e.g. ChromeOS (Linux container), Windows, macOS]
- Python version: [e.g. 3.11]
- ProSe version / branch: [e.g. `main`, `feature/prose-evidence-index-schema`]
- How you ran it:
- [ ] `python -m ...`
- [ ] VS Code terminal
- [ ] Other (describe):

---

## 📝 Additional Context

Add any other context about the problem here.

- Related PRs or branches:
- Donor repo involved (if any): `ProSe_Agent2`, `ProSe-File-Organizer`, etc.

---

## ✔️ Before Submitting

- [ ] I’ve searched existing issues to avoid duplicates
- [ ] I’ve provided clear steps to reproduce
- [ ] I’ve **not** attached real case data, legal documents, or unredacted evidence
- [ ] I’ve included relevant environment details
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/cleanup_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
name: Cleanup Request
about: Report clutter, unused code, or organization issues
title: "[CLEANUP] "
labels: cleanup, maintenance
assignees: ""
---

## 🧹 Cleanup Description

What needs to be cleaned up or reorganized?

---

## 📍 Location

Where in the repository is the issue?

- Path(s):
- Files/directories affected:

---

## 🔍 Issue Type

- [ ] Backup files (*.bak, *.old, etc.)
- [ ] Temporary files
- [ ] Unused/dead code
- [ ] Disorganized structure
- [ ] Outdated documentation
- [ ] Other (describe below)

---

## 💡 Suggested Action

How should this be addressed?

---

## 📊 Impact

- [ ] Low - Minor cleanup
- [ ] Medium - Affects repository organization
- [ ] High - Significant clutter or disorganization

---

## 📝 Additional Details

Any other information about the cleanup needed.

---

## ✔️ Before Submitting

- [ ] I've verified this is actually clutter/needs cleanup
- [ ] I've provided specific location information
- [ ] I've suggested how to address it
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Feature Request
about: Suggest a new feature or enhancement
title: "[FEATURE] "
labels: enhancement
assignees: ""
---

## 🚀 Feature Description

A clear and concise description of the feature you'd like to see.

---

## 🎯 Problem/Motivation

What problem does this feature solve? Why is it needed?

---

## 💡 Proposed Solution

How would you like this feature to work?

---

## 🔄 Alternatives Considered

Have you considered any alternative solutions or features?

---

## 📊 Impact

Who will benefit from this feature? How will it improve the project?

---

## 📝 Additional Context

Add any other context, mockups, or examples about the feature request.

---

## ✔️ Before Submitting

- [ ] I've searched existing issues to avoid duplicates
- [ ] This feature aligns with the project's goals
- [ ] I've clearly described the problem and solution
113 changes: 113 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# 📋 Pull Request Description

## What does this PR do?
<!-- Clearly describe what changes this PR introduces -->

## Why is this change needed?
<!-- Explain the motivation behind these changes -->

## Related Issues
<!-- Link any related issues: Fixes #123, Relates to #456 -->

---

# 🧪 Testing

## How has this been tested?
<!-- Describe the testing you've done -->

- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing completed
- [ ] All tests pass

### Test Coverage
<!-- If applicable, mention test coverage -->

---

# 🧹 Cleanliness Checklist

**CRITICAL**: Ensure your PR maintains repository cleanliness standards

- [ ] **No backup files** (*.bak, *.old, *.backup, etc.)
- [ ] **No temporary files** (*.tmp, temp/, tmp/)
- [ ] **No commented-out code** (delete, don't comment)
- [ ] **No debug statements** (console.log, print, etc.)
- [ ] **No unused imports** or variables
- [ ] **No personal IDE configs** (.vscode/, .idea/, etc.)
- [ ] **No build artifacts** (dist/, build/, compiled files)
- [ ] **No sensitive data** (keys, tokens, passwords)
- [ ] **All files in correct directories** (engine/, tests/, docs/, scripts/, etc.)

---

# 📝 Code Quality Checklist

- [ ] Code follows project style guidelines
- [ ] Functions/methods are documented
- [ ] Complex logic has explanatory comments
- [ ] Error handling is appropriate
- [ ] Code is DRY (Don't Repeat Yourself)

---

# 📚 Documentation

- [ ] README updated (if needed)
- [ ] Documentation added/updated for new features
- [ ] Examples added/updated (if applicable)
- [ ] CHANGELOG updated (if applicable)

---

# 🔍 Review Checklist

Before requesting review, ensure:

- [ ] Self-reviewed all changes
- [ ] Commit messages are clear and descriptive
- [ ] Branch is up to date with main
- [ ] No merge conflicts
- [ ] CI/CD checks pass (if applicable)

---

# 📊 Impact Assessment

### Breaking Changes

- [ ] This PR includes breaking changes
- [ ] Migration guide provided (if breaking changes)

### Performance Impact

<!-- Describe any performance implications -->

### Security Considerations

<!-- Note any security-related changes or considerations -->

---

# 📸 Screenshots/Recordings

<!-- If applicable, add screenshots or recordings of the changes -->

---

# 💬 Additional Notes

<!-- Any other information reviewers should know -->

---

## ✅ Final Confirmation

By submitting this PR, I confirm that:

- [ ] I have read and followed the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
- [ ] I have read and accept the [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md)
- [ ] My code is clean, tested, and ready for review
- [ ] I have removed all clutter, backup, and temporary files
- [ ] This PR maintains the high standards of the ProSe repository
Loading
Loading