Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 1.77 KB
Raw

Contributing to Toolaska Quick Differ

Thank you for your interest in contributing to Quick Differ!

Quick Differ is a free online code comparison and diff tool hosted at https://diff.toolaska.com designed to help developers compare code, text, documents, and configuration files side-by-side with high precision and speed.

🧭 Ways to Contribute

  1. Bug Reports: Open an issue describing unexpected behavior, diff calculation anomalies, or rendering bugs.
  2. Feature Suggestions: Propose new utilities (e.g., additional syntax support, inline diff settings, export enhancements).
  3. Documentation & SEO: Improve guides, fix typos, or suggest SEO and schema enhancements.
  4. Pull Requests: Submit code improvements or optimizations.

🛠️ Contribution Workflow

  1. Clone the Repository:

    git clone https://github.com/toolaska/code-diff-checker.git
cd code-diff-checker

  2. Create a Topic Branch:

    git checkout -b feature/diff-feature

  3. Make Your Changes:

    • Ensure code is clean, readable, and well-documented.
    • Maintain strict client-side data privacy (never transmit user code or text to external services).

  4. Commit with Clear Messages:

    git commit -m "feat: add inline character diff highlight toggle"

  5. Push and Open a Pull Request: Push to your branch and submit a PR to main on toolaska/code-diff-checker.

📋 Code of Conduct

Please treat all community members with respect, kindness, and professionalism. We are committed to providing a welcoming and inclusive environment for everyone.

💬 Questions?

Feel free to open an issue or reach out via our contact page.