Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (54 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

67 lines (54 loc) · 3.9 KB

Contributing to Check

Thanks for taking the time to contribute! These guidelines help keep contributions consistent and reliable for this cross-browser extension.

Development Setup

Chrome/Edge

  • Fork the repository and clone your fork.
  • Run npm run build:chrome to configure for Chrome/Edge.
  • In Chrome or Edge, open chrome://extensions or edge://extensions.
  • Enable Developer mode and choose Load unpacked.
  • Select the repository root to load the extension. Reload the extension after making changes.

Firefox

  • Fork the repository and clone your fork.
  • Run npm run build:firefox to configure for Firefox.
  • In Firefox, open about:debugging#/runtime/this-firefox.
  • Click Load Temporary Add-on and select manifest.json.
  • Reload the extension after making changes.
  • See Firefox Support Guide for more details.

Cross-Browser Compatibility

  • The extension supports Chrome, Edge, and Firefox through browser polyfills.
  • Always test changes in both Chrome and Firefox before submitting.
  • Use the browser polyfill APIs in your code:
    • In ES modules: import { chrome, storage } from "./browser-polyfill.js"
    • In traditional scripts: The polyfill is auto-loaded, just use chrome.* as normal
  • Avoid browser-specific features unless absolutely necessary.

Coding Standards (ESLint)

  • No ESLint configuration is committed to the repository. Maintain the existing code style (2 spaces, semicolons, ES modules).
  • If you have ESLint installed locally, run npx eslint scripts options popup with the default recommended rules and resolve any issues before committing.

Commit Style

  • Use Conventional Commits such as feat:, fix:, or docs: to describe your changes.
  • Keep commits focused and concise.

Testing Expectations

  • Automated tests are not currently available. Manually test changes by loading the extension and verifying:
    • The background service worker/script initializes without errors.
    • Content scripts inject and execute as expected.
    • Options and popup pages function correctly.
  • Test in both Chrome and Firefox to ensure cross-browser compatibility.
  • See Firefox Support Guide for Firefox testing instructions.
  • Include a brief summary of manual testing in your pull request, noting which browsers were tested.

Scripted Deployment Updates

Reporting Security Issues

Security vulnerabilities should be reported privately. Refer to SECURITY.md for disclosure instructions instead of opening public issues or pull requests.

Pull Request Workflow

  1. Create a topic branch from main.
  2. Make your changes and commit them following the guidelines above.
  3. Ensure manual tests pass and any ESLint checks you run are clean.
  4. Push your branch and open a pull request describing the changes and test results.
  5. Address review feedback and update your pull request as needed.

Documentation Expectations

  • When updating or creating a feature, the corresponding documentation in docs should also be updated to reflect your code changes.
  • The documentation hosted at https:docs.check.tech utilizes GitBook which uses mostly GitHub Markdown with some additional syntax. Commit the changes in pure GitHub Markdown while leaving any GitBook sytax in place.
  • New settings should also be added to config/managed_schema.json as this is a central reference for all other documentation