Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (54 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

74 lines (54 loc) · 1.86 KB

Contributing to widget-layout

Prerequisites

  • Node.js >= 16.20.2
  • npm >= 7.24.2
  • /etc/hosts entry for *.foo.redhat.com (run npm run patch:hosts)

Setup

git clone <repo-url>
cd widget-layout
npm install
npm run start

Open the URL shown in terminal output. For local backend integration, see README.md.

Development Workflow

  1. Create a feature branch from master
  2. Make changes following the conventions in AGENTS.md
  3. Run npm run verify (build + lint + test)
  4. Commit using conventional commit format
  5. Open a PR against master

Commit Conventions

Use Conventional Commits:

type(scope): short description

Types: feat, fix, refactor, test, docs, chore, style

Scopes: grid, widgets, hub, api, state, header, drawer

Examples:

feat(grid): add snap-to-grid for widget placement
fix(api): handle 404 when template not found
refactor(state): consolidate layout atoms
test(hooks): add useDashboardConfig error handling tests
docs: update layout data format documentation

Rules:

  • Title line ≤ 50 characters
  • Imperative mood ("add" not "added")
  • Reference Jira ticket key in commit body (not title)
  • Atomic commits — one logical change per commit

Testing

Run tests before submitting:

npm test               # Unit tests (Jest)
npm run test:playwright # E2E tests (Playwright)
npm run lint           # Linting (ESLint + Stylelint)
npm run verify         # All of the above + build

See Testing Guidelines for patterns and conventions.

PR Guidelines

  • Keep PRs focused on a single concern
  • Include screenshots for UI changes
  • Ensure CI passes (lint, test, build)
  • Update documentation if behavior changes
  • Link related Jira tickets