Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (70 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

96 lines (70 loc) · 3.94 KB

Contributing to Traffic Torch 🚀

Thank you for considering contributing to Traffic Torch!
This is an open-source, educational tool for instant 360° SEO + UX health scoring, deep-dive modules, plugin solutions, priority fixes, and predictive rank forecasting.
Built on free GitHub + Cloudflare Pages, fully mobile-optimized, PWA-ready, Day/Night Mode enabled.

We welcome contributions of all sizes and types — from tiny typo fixes to new analysis modules, better educational explanations, UI tweaks, or documentation improvements. Every bit helps make the tool more accurate and useful for users learning SEO/UX best practices.

Code of Conduct

We follow the Contributor Covenant Code of Conduct v2.1.
Be kind, respectful, and inclusive. If you see or experience unacceptable behavior, contact the maintainer via Discussions or Issues.

How to Contribute

1. Found a Bug or Incorrect Result?

→ Use our structured bug report template:
Open Bug Report →

Please include:

  • Clear description of what went wrong vs. expected
  • Steps to reproduce (with domain/URL used)
  • Report URL if generated
  • Affected module (e.g. Core Web Vitals, Competitive Gap, AI Fixes)
  • Environment (browser, OS/device, light/dark mode)
  • Screenshots or console logs (F12 → Console)

This helps us triage and fix quickly.

2. Have a Feature Idea, Question, or General Feedback?

→ Start a Discussion!
Go to Discussions →

Best categories:

  • 💬 General — questions, sharing reports, casual chat
  • 💡 Ideas — new features, UX improvements, educational additions
  • 🙏 Q&A — help with understanding scores or using the tool

Search existing threads first to avoid duplicates. React/upvote popular ideas!

3. Want to Submit Code, Docs, or Design Changes?

Great! Follow these steps:

  1. Fork the repo and create a branch from main
    Use a descriptive branch name:

    • fix/seo-score-calculation-bug
    • feat/add-accessibility-deep-dive
    • docs/improve-mobile-report-layout

  2. Make your changes

    • Keep code clean, readable, and consistent with existing style
    • Add/update comments where needed
    • Ensure mobile responsiveness (test on small screens)
    • Follow latest web best practices (2026 standards: semantic HTML, accessible UI, performant JS)
    • If adding new analysis logic, include educational explanations/tooltips

  3. Test locally

    • Run the site via Cloudflare Pages preview or local server
    • Check light/dark modes, mobile views, report accuracy
    • No breaking changes to core scoring unless discussed first

  4. Commit & push
    Use conventional commit messages (optional but appreciated):
    fix: correct Core Web Vitals LCP calculation
    feat: add tooltip explanations for competitive gap metrics
    docs: improve README screenshots

  5. Open a Pull Request

    • Target the main branch
    • Fill out the PR template (if added later) or describe:
      • What/why changed
      • How tested
      • Screenshots (especially UI/mobile)
      • Related Issue/Discussion link
    • We review quickly — feel free to ping in Discussions if no response in a few days

What We Especially Need Help With

  • Improving educational content (better tooltips, explanations, learning resources)
  • Mobile/UX polish and accessibility enhancements
  • Adding/fixing analysis modules (e.g. more performance metrics, better priorityfix suggestions)
  • Documentation, README screenshots, examples
  • Bug triage, small fixes, typo corrections
  • Testing on different browsers/devices

Questions?

Open a Discussion or comment on an Issue/PR — we're happy to help newcomers!
No contribution is too small.

Thanks for making Traffic Torch better for the SEO/UX community! 🌟

—Ylia