Contribution Guide

Help us make JiukBlocker even smarter and more efficient.

Where to Start?

Whether you're an experienced developer or someone just wanting to suggest a new blocking rule, following this guide makes the process easier.

  • Filter Dictionary: Add new trigger keywords to detect distractions or NSFW content.
  • Platform Support: Improve blocking on specific social networks like TikTok, Instagram, or YouTube.
  • UI/UX: Help improve the popup interface, add new themes, or enhance animations.

Technical Steps

  1. Fork the repository on GitHub.
  2. Create a branch for your feature: git checkout -b feature/NewFeature.
  3. Implement your changes following the project's code standards.
  4. Send a Pull Request detailing what was changed.

Adding a New Filter

To add a new term to the global NSFW dictionary:

  • Open content/General/nsfw_keywords.js.
  • Add your term (as a string or regex) to the exported array.
  • The dictionary is shared across all platform integrations instantly.

Theming System

Want to add a new theme?

  • Open popup/popup.css and define your theme variables under a new class (e.g., body.theme-custom).
  • Add the option to the theme selector in popup/popup.html.
  • Ensure all UI components (buttons, cards, toggles) look consistent in your new theme.

Platform Expansion

Want to add native support for a new site (e.g., Pinterest)?

  • Create a directory in content/Pinterest/.
  • Add logic in content_pinterest.js and styles in styles_pinterest.css.
  • Register the new URL pattern in manifest.json.
  • Hook into the centralized configuration system to respect user toggles.