docs: add PROCESS.md — QMS compliance workflow for GitHub/Jira/Ketryx/Confluence [PYSDK-81]#569
Closed
helmut-hoffer-von-ankershoffen wants to merge 4 commits into
Closed
Conversation
Documents how GitHub PRs, Jira anomaly/change-request tickets, Ketryx releases, and Confluence SOPs (PR-SOP-01, CC-WI-01) relate and must be linked bidirectionally for regulatory compliance. Also describes expected Claude Code behaviour when creating PRs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
helmut-hoffer-von-ankershoffen
added
the
skip:test:long_running
Copilot started reviewing on behalf of
helmut-hoffer-von-ankershoffen
April 24, 2026 13:38
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new top-level engineering process document to explain how GitHub PRs, Jira (Anomaly + Change Request), Ketryx releases, and the Confluence QMS artifacts relate for compliance/traceability in this repo.
Changes:
- Introduces
PROCESS.mddocumenting bug-fix (Anomaly → PR), planned change (Change Request → PR), and release (Ketryx) workflows. - Defines bidirectional linking expectations between GitHub PRs and Jira tickets, plus a quick-reference matrix.
- Adds explicit “Claude Code Workflow” guidance for creating/handling compliance-related PRs.
|
|
||
| 4. Create GitHub PR | ||
| - PR description: link to the CR ticket | ||
| Example: "Implements PYSDK-CR-XX: https://aignx.atlassian.net/browse/PYSDK-XX" |
| | **Ketryx** | Regulated release management — links Jira tickets to releases, collects approvals, enforces traceability | | ||
| | **Confluence (QMS)** | SOPs and work instructions that define the mandatory processes | | ||
|
|
||
| Ketryx sits on top of Jira: it reads Jira tickets of specific types (Anomaly, Change Request) and enforces that they are approved and linked before a release can be closed. A Ketryx release cannot be approved unless all linked items in Jira are in `Closed` status with the required approvals. |
| - Title: follow conventional commits (fix: ...) | ||
| - PR body: include link to the Jira Anomaly ticket | ||
| Example: "Resolves PYSDK-78: https://aignx.atlassian.net/browse/PYSDK-78" | ||
| - Add label: skip:test:long_running |
Comment on lines
+171
to
+174
| 3. Remind you to get CR approval before merging if the CR is not yet Closed | ||
|
|
||
| > **Note**: Anomaly tickets are only required for bugs observed in Staging or Production. | ||
| > Changes made purely during development (before any deployment) do not need an Anomaly ticket per PR-SOP-01. |
Copilot started reviewing on behalf of
helmut-hoffer-von-ankershoffen
April 24, 2026 14:00
View session
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repository-facing process documentation to clarify how GitHub PRs, Jira tickets, Ketryx releases, and Confluence QMS SOPs fit together for compliance/traceability, and updates the Compass component metadata with operational links.
Changes:
- Add
PROCESS.mddescribing the compliance workflow (Anomaly vs Change Request, bidirectional linking, and release flow via Ketryx). - Update
compass.ymlto include links to the Jira board and the public status page.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
compass.yml |
Adds Jira board + status page links to the Compass component definition. |
PROCESS.md |
New engineering process guide documenting Jira↔GitHub traceability expectations and Ketryx release gating. |
Comments suppressed due to low confidence (1)
PROCESS.md:175
- PR description says PROCESS.md includes a "References" section (incl. PR-SOP-01, CC-WI-01, and Atlassian Smart Commits), but the document currently has no dedicated References section. Either add that section with the promised links or update the PR description to match the actual content.
> **Note**: Anomaly tickets are only required for bugs observed in Staging or Production.
> Changes made purely during development (before any deployment) do not need an Anomaly ticket per PR-SOP-01.
|
|
||
| 4. Create GitHub PR | ||
| - PR description: link to the CR ticket | ||
| Example: "Implements PYSDK-CR-XX: https://aignx.atlassian.net/browse/PYSDK-XX" |
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project status has failed because the head coverage (63.74%) is below the target coverage (70.00%). You can increase the head coverage or adjust the target coverage.
|
Contributor
Author
|
obsolete |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🛡️ Implements PYSDK-81 following CC-SOP-01 Change Control, part of our ISO 13485-certified QMS | Ketryx Project
Summary
PROCESS.mddocumenting how GitHub PRs, Jira (Anomaly + Change Request tickets), Ketryx releases, and the Confluence-based QMS (PR-SOP-01, CC-WI-01) relate and must be used together for regulatory complianceWhy
Engineers and AI assistants working in this repo need a single place to understand the compliance obligations — particularly the bidirectional linking requirement between GitHub PRs and Jira tickets — without having to read through multiple Confluence SOPs.
Test plan
PROCESS.mdfor accuracy against PR-SOP-01 and CC-WI-01PYSDK) and ticket URLs are correct🤖 Generated with Claude Code