diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..36d1869 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Report a reproducible product or tool issue +title: '' +labels: '' +assignees: '' +--- + +Please use the repository that owns the affected tool. For a vulnerability, follow SECURITY.md instead of posting details publicly. + +## Product or tool and version + +## Expected behavior + +## Actual behavior + +## Minimal reproduction + +## Environment + +## Relevant evidence + +Remove credentials, private URLs, and customer content before attaching logs or screenshots. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..0721f29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,17 @@ +--- +name: Documentation or feature suggestion +about: Improve documentation or describe a missing workflow +title: '' +labels: '' +assignees: '' +--- + +## Page or tool + +## What is missing or confusing? + +## Expected outcome or suggested change + +## Supporting public links + +Do not include credentials or customer data. diff --git a/.github/workflows/public-docs.yml b/.github/workflows/public-docs.yml new file mode 100644 index 0000000..a4f1f77 --- /dev/null +++ b/.github/workflows/public-docs.yml @@ -0,0 +1,30 @@ +name: Public documentation + +on: + pull_request: + paths: ["**.md", ".github/workflows/public-docs.yml"] + push: + branches: [main] + paths: ["**.md", ".github/workflows/public-docs.yml"] + workflow_dispatch: + schedule: + - cron: "19 8 * * 1" + +permissions: + contents: read + +jobs: + links: + runs-on: ubuntu-latest + timeout-minutes: 10 + steps: + - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5 + - name: Require the canonical documentation entry point + run: python3 -c "from pathlib import Path; assert 'https://docs.qualitymax.io/' in Path('profile/README.md').read_text(), 'The entry README must link to canonical documentation'" + - name: Check Markdown links and local anchors + uses: lycheeverse/lychee-action@e7477775783ea5526144ba13e8db5eec57747ce8 # v2 + with: + lycheeVersion: v0.24.2 + args: --no-progress --include-fragments --timeout 30 --max-retries 2 'profile/**/*.md' '*.md' + fail: true + jobSummary: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bf5a5d1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contributing to QualityMax + +Use the issue tracker in the repository that owns the tool or documentation you want to improve. Before opening an issue, search for an existing report and check the [documentation](https://docs.qualitymax.io/). + +For a bug report, include the version, environment, expected behavior, actual behavior, and a minimal reproduction. Remove credentials and customer data from logs and screenshots. Report sensitive vulnerabilities through [SECURITY.md](SECURITY.md). + +For a change, create a branch and open a focused pull request. Follow the repository's own contribution instructions, preserve its license, and run checks appropriate to the change. Product setup and feature documentation should link to the canonical docs instead of duplicating volatile instructions. + +For product questions that cannot be discussed publicly, contact **contact@qualitymax.io**. This guidance does not promise a support response time. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..f6324f4 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Security policy + +Report a suspected vulnerability privately to **contact@qualitymax.io**. Include the affected repository or product, version, impact, and a concise reproduction using a controlled example. Do not include live credentials or customer data, and do not open a public issue containing sensitive details. + +We will coordinate investigation and disclosure with you. Avoid accessing or changing other users' data. A repository-specific security policy takes precedence over the organization default. + +For ordinary bugs and documentation feedback, use the repository issue tracker. Product guidance is available at [docs.qualitymax.io](https://docs.qualitymax.io/). diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..88fc5da --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,9 @@ +# Getting help + +- [Documentation](https://docs.qualitymax.io/): product behavior, setup, and troubleshooting. +- [Web app](https://app.qualitymax.io): hosted account and project workflows. +- [Public product guide](https://github.com/Quality-Max/qualitymax): features, examples, and the tool directory. + +For a tool bug, open an issue in that tool's repository with its version and a minimal reproduction. For documentation feedback, use the [product guide issue tracker](https://github.com/Quality-Max/qualitymax/issues). + +For private product questions, contact **contact@qualitymax.io**. For vulnerabilities, follow [SECURITY.md](SECURITY.md). Never post credentials, customer data, or private execution artifacts in a public issue. diff --git a/profile/README.md b/profile/README.md index 85c29b5..4507c37 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,101 +1,51 @@ +# QualityMax -

- QualityMax -

+**Independent verification for AI-written code.** -

AI-Native Test Automation Platform

+Discover user journeys, generate and run tests, review changes, and inspect the evidence behind your next release. -

- UI testing, API testing, performance testing, and security scanning — all powered by AI. -

+[Website](https://qualitymax.io) · [Open QualityMax](https://app.qualitymax.io) · [Documentation](https://docs.qualitymax.io/) · [Standalone tools](https://docs.qualitymax.io/free-and-open-source/) -

- qualitymax.io  ·  - qmax-code  ·  - Releases  ·  - Test Grader  ·  - Supply Chain Scanner -

+## Start here -

- Join our Discord -

- ---- - -## qmax-code — AI Testing Agent for Your Terminal - -``` - ██████╗ ███╗ ███╗ █████╗ ██╗ ██╗ - ██╔═══██╗████╗ ████║██╔══██╗╚██╗██╔╝ - ██║ ██║██╔████╔██║███████║ ╚███╔╝ - ██║▄▄ ██║██║╚██╔╝██║██╔══██║ ██╔██╗ - ╚██████╔╝██║ ╚═╝ ██║██║ ██║██╔╝ ██╗ - ╚══▀▀═╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝ - c o d e -``` - -**The first AI testing agent built for the terminal.** 49 tools, natural language interface, self-healing scripts. Named after Max, the real cat. Now open source under [FSL-1.1-ALv2](https://github.com/Quality-Max/qmax-code/blob/main/LICENSE). - -```bash -curl -sL https://raw.githubusercontent.com/Quality-Max/qmax-code/main/install.sh | bash -``` - -**What it does:** You talk to Max in plain English. He crawls your app, generates Playwright tests, executes them on the cloud, auto-heals failures, runs k6 load tests, and exports CI/CD frameworks — all without leaving your terminal. - -**v1.13.1** — themes (Historic, Ocean, Neon, Ember, Aurora), thinking spinner, prompt queue, input fixes. - -

- Product Page  ·  - Download  ·  - Source & Docs -

- ---- - -## What We Build - -QualityMax is an AI-native quality platform that covers four testing layers: - -- **UI Testing** — AI crawls your web app, generates Playwright tests, self-heals when UI changes -- **API Testing** — Import OpenAPI specs or repos, generate endpoint tests with proper assertions -- **Performance Testing** — k6 load, stress, spike, soak tests with trend dashboards and regression detection -- **Security Scanning** — Integrated SAST with Semgrep, Bandit, and secret detection +| Your workflow | Get started | +|---|---| +| Use the platform to manage tests and inspect runs | [Web app quickstart](https://docs.qualitymax.io/quickstart-web-app/) | +| Connect your coding agent to hosted QualityMax | [MCP quickstart](https://docs.qualitymax.io/quickstart-mcp/) | +| Work locally with standalone tools | [qmax-mcp](https://github.com/Quality-Max/qmax-mcp), [qmax-code](https://github.com/Quality-Max/qmax-code), or [QA skills](https://github.com/Quality-Max/free-qa-skills) | -Built by a QA engineer with 19 years of experience. Berlin-based. +Hosted workflows use a QualityMax account. Standalone tools have their own prerequisites; model-assisted workflows may require a model provider or coding-agent subscription. ---- +## What you can do -## Open Source +- **Turn user journeys into coverage.** Generate tests, execute them, and inspect results and available artifacts. [Start a first run →](https://docs.qualitymax.io/quickstart-web-app/) +- **Verify pull requests.** Combine code review, supported native test suites, generated-test feedback, and preview-browser checks. Gate availability and enforcement depend on configuration. [PR gates →](https://docs.qualitymax.io/code-review-gates/) +- **Get specialist review.** Use Nexus for attributed findings and shareable review reports. [Nexus →](https://docs.qualitymax.io/nexus-review/) +- **Evaluate AI applications.** Assess conversations and hallucination risks, and explore browser journeys with simulated users. [AI validation →](https://docs.qualitymax.io/ai-validation/) · [Agentic Eyes →](https://docs.qualitymax.io/agentic-eyes/) +- **Investigate and repair failing tests.** Review failure evidence and proposed repairs. [Self-healing →](https://docs.qualitymax.io/self-healing/) +- **Bring project context into Slack.** Ask project-aware questions and review supported action proposals. [Slack →](https://docs.qualitymax.io/slack/) · [Memory and grounding →](https://docs.qualitymax.io/memory-grounding/) +- **Manage and reuse test assets.** Organize cases and scripts, work with performance tests, and exchange QTML assets. [Test management →](https://docs.qualitymax.io/test-management/) · [Performance →](https://docs.qualitymax.io/performance/) · [QTML →](https://docs.qualitymax.io/export-qtml/) -| Repository | Description | -|---|---| -| [**qmax-code**](https://github.com/Quality-Max/qmax-code) | AI testing agent source code. 49 tools, self-healing, cloud execution. FSL-1.1-ALv2 → Apache 2.0 after 2 years. | -| [**qmax-code-releases**](https://github.com/Quality-Max/qmax-code-releases) | Pre-built binaries for macOS, Linux, and Windows. | -| [**qualitymax-grader**](https://github.com/Quality-Max/qualitymax-grader) | Lighthouse for test quality. Grade Playwright tests A-F. 17 checks, GitHub Action. | -| [**supply-chain-scanner**](https://github.com/Quality-Max/supply-chain-scanner) | Detect supply chain attacks in Python deps — .pth injection, typosquatting, encoded payloads. | -| [**qmax-local-agent**](https://github.com/Quality-Max/qmax-local-agent) | Go CLI agent for running Playwright tests behind firewalls, on localhost, against staging. | +## Explore the tools ---- +| Project | Purpose | License / status | +|---|---|---| +| [qmax-mcp](https://github.com/Quality-Max/qmax-mcp) | Local browser inspection, scanning, Playwright reproduction generation, and test execution through MCP | MIT; standalone and optional hosted proxy modes | +| [qmax-code](https://github.com/Quality-Max/qmax-code) | Terminal agent for coding and testing, with standalone and connected workflows | Source available, FSL-1.1-ALv2 | +| [Free QA Skills](https://github.com/Quality-Max/free-qa-skills) | Reusable QA workflows for supported coding agents | Apache-2.0 | +| [9lives](https://github.com/Quality-Max/9lives) | Local test repair with reruns and reviewable diffs | MIT; prototype | +| [Test Grader](https://github.com/Quality-Max/qualitymax-grader) | Static Playwright test-quality grading | Apache-2.0 | +| [Supply Chain Scanner](https://github.com/Quality-Max/supply-chain-scanner) | Python dependency supply-chain checks | Apache-2.0 | +| [qmax local agent](https://github.com/Quality-Max/qmax-local-agent) | CLI and local execution agent for platform workflows | Apache-2.0 | -## Platform Highlights +See each repository for its current requirements and limitations. The hosted platform and individual tools have different licensing and availability. -- **49 tools via qmax-code** — the only terminal AI agent purpose-built for QA -- **50+ MCP tools** — deepest AI assistant integration in QA (Claude, Cursor, Windsurf) -- **6 LLM providers** — Anthropic, OpenAI, Gemini, DeepSeek, Mistral, Grok with automatic fallback -- **BYOLLM** — bring your own API keys, full cost transparency -- **CI/CD native** — GitHub Actions, GitLab CI, deploy hooks +For integrations that embed QualityMax, see [Partner / White-label](https://docs.qualitymax.io/partner-white-label/). For responsive audits and managed flows, see [Mobile](https://docs.qualitymax.io/mobile/). Learn how to interpret [evidence and receipts](https://docs.qualitymax.io/evidence-trust/). ---- +## See examples and integrations -

- Max the cat -

+[qmax-mcp demo](https://github.com/Quality-Max/qmax-mcp/tree/main/demo) · [9lives repair demo](https://github.com/Quality-Max/9lives/blob/main/demo/heal.gif) · [GitHub Action](https://github.com/Quality-Max/qualitymax-github-action) · [n8n workflows](https://github.com/Quality-Max/n8n-nodes-qualitymax) · [qmax-code releases](https://github.com/Quality-Max/qmax-code/releases/latest) ---- +For the wider platform, visit the [public product guide](https://github.com/Quality-Max/qualitymax) and [documentation](https://docs.qualitymax.io/). Sovereign deployment is available as a [private preview](https://docs.qualitymax.io/deployment/). -

- qualitymax.io  ·  - Discord Community  ·  - Berlin, Germany -

+To contribute to a tool, start with its repository's contribution guidance and issue tracker.