-
Notifications
You must be signed in to change notification settings - Fork 0
refactor(v2.0.0 release): user-defined tags, project storage, and documentation standards #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,77 @@ | ||
| # Annotative VSCode Extension | ||
| # Annotative VS Code Extension | ||
|
|
||
| A productivity tool for code annotation - perfect for reviewing AI-generated code, collaborating on pull requests, and taking notes while coding. | ||
| Code annotation and review workflows for VS Code. Add comments to code selections, organize with custom tags, and export as Markdown. | ||
|
|
||
| ## Product Positioning | ||
|
|
||
| - **Primary Use Case**: Review AI-generated code changes from Copilot, ChatGPT, Claude, etc. | ||
| - **Secondary Use Cases**: Code reviews, note-taking, team collaboration, documentation | ||
| - **Key Value**: Simple annotation with export to Markdown for AI chats and discussions | ||
| - **Primary Use Case**: Reviewing AI-generated code changes from Copilot, ChatGPT, Claude, etc. | ||
| - **Secondary Use Cases**: Code reviews, documentation, issue tracking, team collaboration | ||
| - **Key Value**: Simple annotation system with Markdown export optimized for AI tools and team discussions | ||
|
|
||
| ## Development Guidelines | ||
|
|
||
| - Follow TypeScript best practices for VS Code extensions | ||
| - Use the VS Code Extension API for UI components and editor interactions | ||
| - Use VS Code Extension API for UI components and editor interactions | ||
| - Implement proper error handling and user feedback | ||
| - Store annotations in workspace-specific files | ||
| - Keep the UI simple and intuitive - lightweight input boxes instead of complex webviews | ||
| - Ensure export format is optimized for pasting into AI chats | ||
| - Focus on speed and simplicity over complex UI | ||
| - Store annotations per workspace in `.annotative/` folder or global state | ||
| - Keep UI simple - use native VS Code input boxes and quick picks | ||
| - Ensure export formats are optimized for AI tools | ||
| - Focus on speed and simplicity | ||
|
|
||
| ## Architecture | ||
|
|
||
| ### Core Structure | ||
|
|
||
| - Main extension file: `src/extension.ts` | ||
| - Annotation management: `src/annotationManager.ts` | ||
| - UI components: `src/ui/annotationProvider.ts` (sidebar tree view only) | ||
| - Types and interfaces: `src/types.ts` | ||
| - Command modules: `src/commands/` (organized by feature area) | ||
| - Core managers: `src/managers/` (AnnotationManager, etc.) | ||
| - Tag system: `src/tags/` (TagManager, validation, suggestions) | ||
| - UI components: `src/ui/` (webview sidebar, providers) | ||
| - Type definitions: `src/types.ts` | ||
| - Copilot integration: `src/copilotExporter.ts` and `src/copilotChatParticipant.ts` | ||
|
|
||
| ### Command Organization | ||
|
|
||
| Commands are organized in separate modules: | ||
|
|
||
| - `annotation.ts` - Add, remove, edit, toggle, undo | ||
| - `export.ts` - Export to clipboard, document, AI formats | ||
| - `filters.ts` - Filter by status, tag, search, clear | ||
| - `bulk.ts` - Bulk operations (resolve all, delete all) | ||
| - `navigation.ts` - Navigate between annotations | ||
| - `sidebar.ts` - Sidebar view management, project storage | ||
| - `tags.ts` - Custom tag CRUD operations | ||
|
|
||
| ## Key Features | ||
|
|
||
| 1. Quick annotation with keyboard shortcuts and context menus | ||
| 2. Simple input boxes for adding/editing annotations (no complex webviews) | ||
| 3. Visual highlighting with editor decorations | ||
| 4. Flexible tagging system (bug, performance, security, style, improvement, docs, question, ai-review) | ||
| 5. Resolution tracking | ||
| 6. Markdown export optimized for AI chats and team discussions | ||
| 7. Sidebar tree view for organization | ||
| 8. Persistent workspace storage | ||
| 9. Template support for common annotation scenarios | ||
| 10. Direct Copilot Chat integration (@annotative participant) | ||
| 1. Quick annotation with keyboard shortcuts (Ctrl+Shift+A / Cmd+Shift+A) | ||
| 2. Native VS Code input boxes for comments and tags | ||
| 3. Visual highlighting with eight color options | ||
| 4. Custom tag system - all tags are user-defined | ||
| 5. Resolution tracking and status management | ||
| 6. Markdown export optimized for AI tools | ||
| 7. Webview sidebar with grouping and filtering | ||
| 8. Project-based storage in `.annotative/` folder | ||
| 9. Template support for common scenarios | ||
| 10. GitHub Copilot Chat integration via @annotative participant | ||
|
|
||
| ## Naming Conventions | ||
|
|
||
| Use exact command names and terminology from the extension: | ||
|
|
||
| - "Add Annotation" not "Create Annotation" | ||
| - "Toggle Status" not "Mark Resolved" | ||
| - "Remove" not "Delete" (in UI) | ||
| - "Export to Clipboard" not "Copy Export" | ||
| - "Filter by Status" and "Filter by Tag" | ||
| - "Storage Info" not "Show Storage" | ||
|
|
||
| ## No Emojis | ||
|
|
||
| Do not use emojis in: | ||
|
|
||
| - Code or comments | ||
| - Documentation | ||
| - Commit messages | ||
| - User-facing text | ||
| - UI labels | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.