Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 2.57 KB

Contributing to Endatix Hub

Thank you for helping. This page says how to name a branch and a pull request. Setup and running the project are in the README; the coding rules that people and agents follow are in AGENTS.md.

Start from an issue

Every pull request closes an issue in this repository. Find one, or open one, before you start, so the change is agreed first. Put Closes #<issue> in the pull request body.

Branch names

<type>/h<issue>-<slug>

For example feat/h1156-test-inspector-gate. <type> is one of the title types below, and <slug> is a few lowercase words joined by dashes.

Pull request titles

Pull requests are squash-merged, so the title becomes the commit on main and feeds the release notes. Use Conventional Commits with the issue key as the scope:

<type>(h<issue>): <subject>
  • Type: feat, fix, docs, style, refactor, perf, test, build, ci, chore, or revert.
  • Scope: h and the issue number, for example feat(h1156): replace the test badge with the Test inspector for testers for #1156. Dependency bumps use deps or deps-dev instead, as Dependabot does: chore(deps): bump ….
  • Subject: imperative, says what changes for the user, and has no trailing period.

Pull request body

Fill in the pull request template: what changed and why, the issue it closes, and how you tested it.

Review rules

A reviewer checks every pull request against these, besides the rules in AGENTS.md.

  • A control that calls a guarded API action has the API's permission. The page or component shows the control only with the permission the API endpoint requires, under the same name, and the server action the control calls checks that permission too (requirePermission, requireAllPermissions, or a feature helper that calls them, see AGENTS.md → Server Actions). "The same name" is the permission string the API endpoint checks, for example forms.edit. The review cites the API rule it compared against: the endpoint and its permission.
  • A pending async action disables its trigger, and Cancel or Discard is proven. While the action runs, the button, menu item or form that started it is disabled (or shows a pending state that ignores a second click), so the action never fires twice. Cancel and Discard each have a test that checks the effect, such as the draft is gone, the dialog is closed or the API was not called, not just that the handler ran.