Skip to content
Closed
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
56 changes: 56 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
{
"root": true,
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 2022,
"sourceType": "module"
},
"plugins": ["@typescript-eslint", "prettier"],
"extends": ["eslint:recommended", "prettier"],
"env": {
"node": true,
"es2022": true,
"jest": true
},
"rules": {
"prettier/prettier": "error",
"@typescript-eslint/no-unused-vars": [
"error",
{
"argsIgnorePattern": "^_",
"varsIgnorePattern": "^_"
}
],
"@typescript-eslint/no-explicit-any": "warn",
"no-console": ["warn", { "allow": ["warn", "error"] }],
"no-debugger": "error",
"no-duplicate-imports": "error",
"no-unused-expressions": "error",
"prefer-const": "error",
"no-var": "error",
"object-shorthand": "error",
"prefer-arrow-callback": "error",
"prefer-template": "error",
"eqeqeq": ["error", "always"],
"curly": ["error", "all"],
"spaced-comment": [
"error",
"always",
{
"markers": ["/"],
"exceptions": ["-", "+", "*"]
}
],
"no-throw-literal": "error"
},
"overrides": [
{
"files": ["**/*.test.ts", "**/*.spec.ts", "tests/**/*.ts"],
"rules": {
"@typescript-eslint/no-explicit-any": "off",
"no-console": "off"
}
}
],
"ignorePatterns": ["node_modules/", "dist/", "build/", "coverage/", "*.d.ts"]
}
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG] '
labels: ['bug', 'needs-triage']
assignees: ''
---

## Bug Description
A clear and concise description of what the bug is.

## To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected Behavior
A clear and concise description of what you expected to happen.

## Actual Behavior
A clear and concise description of what actually happened.

## Environment
- **OS**: [e.g. macOS 14.5, Windows 11, Ubuntu 22.04]
- **Node.js Version**: [e.g. 18.17.0]
- **Bear MCP Server Version**: [e.g. 1.0.0]
- **Bear App Version**: [e.g. 2.1.4]
- **Claude Desktop Version**: [e.g. 1.2.3]

## Configuration
```json
// Your MCP configuration (remove sensitive data)
{
"mcpServers": {
"bear": {
// configuration here
}
}
}
```

## Error Logs
```
// Paste any error logs here
```

## Screenshots
If applicable, add screenshots to help explain your problem.

## Service Health
Run the health check and paste the output:
```bash
# Health check command output
```

## Additional Context
Add any other context about the problem here.

## Checklist
- [ ] I have searched existing issues to ensure this is not a duplicate
- [ ] I have provided all the requested information
- [ ] I have tested with the latest version
- [ ] I have checked the documentation
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Feature Request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: ['enhancement', 'needs-triage']
assignees: ''
---

## Feature Description
A clear and concise description of what you want to happen.

## Problem Statement
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

## Proposed Solution
A clear and concise description of what you want to happen.

## Alternative Solutions
A clear and concise description of any alternative solutions or features you've considered.

## Use Cases
Describe the use cases for this feature:
1. As a [user type], I want [goal] so that [benefit]
2. When [situation], I expect [behavior]

## Implementation Ideas
If you have ideas about how this could be implemented, please describe them here.

## Service Impact
Which services would this feature affect?
- [ ] DatabaseService
- [ ] NoteService
- [ ] SearchService
- [ ] TagService
- [ ] CacheService
- [ ] LoggingService
- [ ] HealthService
- [ ] ValidationService
- [ ] New Service Required

## Acceptance Criteria
- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3

## Additional Context
Add any other context, mockups, or examples about the feature request here.

## Checklist
- [ ] I have searched existing issues to ensure this is not a duplicate
- [ ] I have provided a clear use case for this feature
- [ ] I have considered the impact on existing functionality
- [ ] This feature aligns with the project's goals
98 changes: 98 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
## Description
Brief description of the changes in this PR.

## Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring
- [ ] Test improvements

## Related Issues
Fixes #(issue number)
Relates to #(issue number)

## Changes Made
### Services Modified
- [ ] DatabaseService
- [ ] NoteService
- [ ] SearchService
- [ ] TagService
- [ ] CacheService
- [ ] LoggingService
- [ ] HealthService
- [ ] ValidationService

### Specific Changes
- Change 1: Description
- Change 2: Description
- Change 3: Description

## Testing
### Test Coverage
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] All existing tests pass
- [ ] New tests pass
- [ ] Test coverage maintained/improved

### Manual Testing
- [ ] Tested locally with Bear app
- [ ] Tested with Claude Desktop
- [ ] Tested error scenarios
- [ ] Performance impact verified

### Test Results
```bash
# Paste test results here
npm test
```

## Performance Impact
- [ ] No performance impact
- [ ] Performance improved
- [ ] Performance impact acceptable
- [ ] Performance benchmarks included

## Documentation
- [ ] README updated (if needed)
- [ ] API documentation updated
- [ ] Developer guide updated
- [ ] Architecture documentation updated
- [ ] Comments added to complex code

## Breaking Changes
- [ ] No breaking changes
- [ ] Breaking changes documented
- [ ] Migration guide provided
- [ ] Version bump required

## Security Considerations
- [ ] No security implications
- [ ] Security review completed
- [ ] Input validation added/updated
- [ ] Authentication/authorization changes

## Deployment
- [ ] No deployment changes needed
- [ ] Environment variables updated
- [ ] Database migrations included
- [ ] Configuration changes documented

## Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published

## Screenshots/Videos
If applicable, add screenshots or videos to demonstrate the changes.

## Additional Notes
Any additional information that reviewers should know.
Loading
Loading