Skip to content

Polish docs and project metadata#18

Merged
jonmartin721 merged 2 commits intomainfrom
touchup/docs-polish
Mar 9, 2026
Merged

Polish docs and project metadata#18
jonmartin721 merged 2 commits intomainfrom
touchup/docs-polish

Conversation

@jonmartin721
Copy link
Owner

Summary

  • tighten README, privacy, and security copy to match the current implementation
  • align author and package metadata across project files
  • ignore common local AI assistant instruction files and carry over local file-mode cleanup

Testing

  • npm test -- --runInBand
  • npm run build

@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the project's foundational documentation and metadata. It refines user-facing information in the README, privacy policy, and security policy to accurately reflect the current implementation. Additionally, it standardizes project metadata across configuration files and improves the .gitignore to better manage development artifacts.

Highlights

  • Documentation Refinement: The README.md, PRIVACY.md, and SECURITY.md files have been updated to provide clearer, more accurate, and current descriptions of the project's features, data handling, and security posture.
  • Project Metadata Alignment: Author information and project descriptions in manifest.json and package.json have been standardized for consistency.
  • Git Ignore Enhancements: The .gitignore file was expanded to include a comprehensive list of common AI assistant instruction files, preventing their accidental inclusion in the repository.
  • Test Documentation Update: The tests/README.md file was updated to provide more context on the test suite, including types of tests, coverage thresholds, and their limitations.
Changelog
  • .gitignore
    • Added a new section for AI assistant instruction files, including AGENTS.md, GEMINI.md, QWEN.md, AIDER.md, CURSOR.md, COPILOT.md, CODEIUM.md, WINDSURF.md, and CONTINUE.md.
    • Moved CLAUDE.md from "Local dev notes" to the new "AI assistant instruction files" section.
  • PRIVACY.md
    • Updated the "Last Updated" date to "March 8, 2026".
    • Revised the overview to be more concise about what the extension stores and doesn't collect.
    • Clarified the description of GitHub Personal Access Token storage and encryption.
    • Updated the description of Activity Data cleanup.
    • Refined the "Data Storage" section to detail Chrome storage API usage and token handling.
    • Reworded the "Security" section to provide more concrete safeguards and a disclaimer about formal audits.
    • Corrected the developer's name from "Jonathan Martinez" to "Jonathan Martin".
  • README.md
    • Rewrote the introductory sentence to better describe the extension's functionality.
    • Updated descriptions for "Guided Setup" and "Secure & Private" features.
    • Removed "Takes about 2 minutes. No configuration knowledge needed." from the "First-Time Setup" section.
    • Renamed "Accessibility" to "Accessibility Notes" and provided a more detailed explanation of UI features and testing, along with a disclaimer about formal audits.
    • Renamed "Privacy & Security" to "Privacy & Security Notes" and expanded on network access, browser permissions, defensive code, and audit disclaimers.
    • Updated the "Running Tests" section to include npm run lint, npm run typecheck, and npm run build, along with detailed explanations of test coverage and limitations.
    • Changed "This is a side project for me..." to "This is an actively maintained side project." in the Roadmap section.
    • Removed the "Star this repo" prompt and simplified the footer image.
  • SECURITY.md
    • Changed the heading "Security Measures" to "Current Security Posture" and added a disclaimer about formal audits.
    • Refined the "Token Storage" description to clarify encryption and session caching.
    • Updated the "Content Security Policy" description to be more specific about script sources and network destinations.
    • Reworded "Input Validation" to "The codebase includes sanitization for rendered content".
    • Updated "Supported Versions" to refer to the current 1.0.x release line for security fixes.
  • manifest.json
    • Updated the description field to "Monitor pull requests, issues, and releases across GitHub repositories with notifications and a local activity feed."
    • Corrected the author field from "Jonathan Martinez" to "Jonathan Martin".
  • package.json
    • Updated the description field to "Chrome extension for monitoring GitHub repository activity."
  • tests/README.md
    • Corrected "GitHub DevWatch" to "GitHub Devwatch".
    • Added a paragraph explaining the nature of the tests (unit/DOM-focused integration) and their limitations.
    • Renamed "Coverage Goals" to "Coverage Thresholds".
    • Updated the minimum coverage thresholds for lines, branches, and functions to higher percentages (47%, 46%, 44% respectively).
    • Added a note that thresholds are guardrails, not a claim of exhaustive coverage.
Activity
  • No human activity has been recorded on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@sentry
Copy link

sentry bot commented Mar 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request focuses on polishing documentation and project metadata. The changes across README.md, PRIVACY.md, and SECURITY.md provide clearer and more accurate information to users, which is a great improvement. The project metadata has also been aligned across manifest.json and package.json. I have one minor suggestion to improve the maintainability of the new entries in the .gitignore file.

Note: Security Review has been skipped due to the limited scope of the PR.

.gitignore Outdated
Comment on lines +22 to +31
AGENTS.md
CLAUDE.md
GEMINI.md
QWEN.md
AIDER.md
CURSOR.md
COPILOT.md
CODEIUM.md
WINDSURF.md
CONTINUE.md

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To improve long-term maintainability, consider sorting the list of AI assistant instruction files alphabetically. This will make it easier to see what's being ignored and to add new files in the future.

AIDER.md
AGENTS.md
CLAUDE.md
CODEIUM.md
COPILOT.md
CONTINUE.md
CURSOR.md
GEMINI.md
QWEN.md
WINDSURF.md

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorted the AI instruction ignore block while updating the branch. Thanks.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

echo "Running pre-commit lint check..."

P2 Badge Restore executable bit on Husky hook scripts

This commit changes .husky/pre-commit (and .husky/pre-push) from mode 100755 to 100644, which makes Git ignore the hooks when Husky sets core.hooksPath to .husky during npm run prepare. In that state, commit/push checks stop running (git reports the hook is ignored because it is not executable), so lint/validate gates are silently bypassed in normal contributor workflows.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@jonmartin721
Copy link
Owner Author

Follow-up pushed in 59aebb4: restored executable bits on the Husky hooks and scripts/build.js, and sorted the AI instruction ignore block.

@jonmartin721 jonmartin721 merged commit 719b2fe into main Mar 9, 2026
2 checks passed
@jonmartin721 jonmartin721 deleted the touchup/docs-polish branch March 9, 2026 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant