Use this file as the stable entrypoint for contributing to signoz-web.
- Contributors should start here, then open the task-specific playbook that matches the change.
- Reviewers and agents should use this file as the router and
contributing/**as the detailed guidance source. - Development setup and local preview still live in README.md.
- Write or update docs (includes redirects and discovery)
- Review docs PRs
- Change site code
- Publish or update a blog post
- Follow the shared repo workflow
- Use contributor templates
contributing/**contains the canonical task-level policy, checklists, and templates.AGENTS.md, review skills, PR templates, and workflow prompts should link to those playbooks instead of duplicating them.
Use the canonical verification matrix in contributing/repo-workflow.md.
- Fork and clone the repo.
- Create a focused branch.
- Make task-scoped changes.
- Run the checks that match your files using the matrix in contributing/repo-workflow.md.
- Open the PR as Draft by default.
- Mark it ready only after checks and self-review are complete.
See contributing/repo-workflow.md for Git hooks, CI checks, and failure handling.
- Keep changes minimal and scoped to the task.
- Use existing patterns before creating new abstractions.
- Do not bypass failing checks silently.
- If a docs URL changes, also handle redirects, sidebar updates, and any discovery surfaces.
- For OpenTelemetry technical claims, verify against official OpenTelemetry docs or repositories.
- Docs structure, JTBD guidance, snippets, redirects, and Send Data rules: contributing/docs-authoring.md
- Docs review rubric and onboarding label policy: contributing/docs-review.md
- Frontend conventions and MDX rendering constraints: contributing/site-code.md
- Blog-specific workflow: contributing/blog-workflow.md
- Reusable templates and checklist snippets: contributing/templates/