@groupby/ai-dev 0.5.10 → 0.5.11

package/teams/fhr-neowise/skills/mermaid-diagram/references/zenuml.md

@@ -0,0 +1,474 @@
+> **Warning**
+>
+> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
+>
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/syntax/zenuml.md](../../packages/mermaid/src/docs/syntax/zenuml.md).
+
+# ZenUML
+
+> A Sequence diagram is an interaction diagram that shows how processes operate with one another and in what order.
+
+Mermaid can render sequence diagrams with [ZenUML](https://zenuml.com). Note that ZenUML uses a different
+syntax than the original Sequence Diagram in mermaid.
+
+```mermaid-example
+zenuml
+    title Demo
+    Alice->John: Hello John, how are you?
+    John->Alice: Great!
+    Alice->John: See you later!
+```
+
+```mermaid
+zenuml
+    title Demo
+    Alice->John: Hello John, how are you?
+    John->Alice: Great!
+    Alice->John: See you later!
+```
+
+## Syntax
+
+### Participants
+
+The participants can be defined implicitly as in the first example on this page. The participants or actors are
+rendered in order of appearance in the diagram source text. Sometimes you might want to show the participants in a
+different order than how they appear in the first message. It is possible to specify the actor's order of
+appearance by doing the following:
+
+```mermaid-example
+zenuml
+    title Declare participant (optional)
+    Bob
+    Alice
+    Alice->Bob: Hi Bob
+    Bob->Alice: Hi Alice
+```
+
+```mermaid
+zenuml
+    title Declare participant (optional)
+    Bob
+    Alice
+    Alice->Bob: Hi Bob
+    Bob->Alice: Hi Alice
+```
+
+### Annotators
+
+If you specifically want to use symbols instead of just rectangles with text you can do so by using the annotator syntax to declare participants as per below.
+
+```mermaid-example
+zenuml
+    title Annotators
+    @Actor Alice
+    @Database Bob
+    Alice->Bob: Hi Bob
+    Bob->Alice: Hi Alice
+```
+
+```mermaid
+zenuml
+    title Annotators
+    @Actor Alice
+    @Database Bob
+    Alice->Bob: Hi Bob
+    Bob->Alice: Hi Alice
+```
+
+Here are the available annotators:
+![img.png](img/zenuml-participant-annotators.png)
+
+### Aliases
+
+The participants can have a convenient identifier and a descriptive label.
+
+```mermaid-example
+zenuml
+    title Aliases
+    A as Alice
+    J as John
+    A->J: Hello John, how are you?
+    J->A: Great!
+```
+
+```mermaid
+zenuml
+    title Aliases
+    A as Alice
+    J as John
+    A->J: Hello John, how are you?
+    J->A: Great!
+```
+
+## Messages
+
+Messages can be one of:
+
+1. Sync message
+2. Async message
+3. Creation message
+4. Reply message
+
+### Sync message
+
+You can think of a sync (blocking) method in a programming language.
+
+```mermaid-example
+zenuml
+    title Sync message
+    A.SyncMessage
+    A.SyncMessage(with, parameters) {
+      B.nestedSyncMessage()
+    }
+```
+
+```mermaid
+zenuml
+    title Sync message
+    A.SyncMessage
+    A.SyncMessage(with, parameters) {
+      B.nestedSyncMessage()
+    }
+```
+
+### Async message
+
+You can think of an async (non-blocking) method in a programming language.
+Fire an event and forget about it.
+
+```mermaid-example
+zenuml
+    title Async message
+    Alice->Bob: How are you?
+```
+
+```mermaid
+zenuml
+    title Async message
+    Alice->Bob: How are you?
+```
+
+### Creation message
+
+We use `new` keyword to create an object.
+
+```mermaid-example
+zenuml
+    new A1
+    new A2(with, parameters)
+```
+
+```mermaid
+zenuml
+    new A1
+    new A2(with, parameters)
+```
+
+### Reply message
+
+There are three ways to express a reply message:
+
+```mermaid-example
+zenuml
+    // 1. assign a variable from a sync message.
+    a = A.SyncMessage()
+
+    // 1.1. optionally give the variable a type
+    SomeType a = A.SyncMessage()
+
+    // 2. use return keyword
+    A.SyncMessage() {
+    return result
+    }
+
+    // 3. use @return or @reply annotator on an async message
+    @return
+    A->B: result
+```
+
+```mermaid
+zenuml
+    // 1. assign a variable from a sync message.
+    a = A.SyncMessage()
+
+    // 1.1. optionally give the variable a type
+    SomeType a = A.SyncMessage()
+
+    // 2. use return keyword
+    A.SyncMessage() {
+    return result
+    }
+
+    // 3. use @return or @reply annotator on an async message
+    @return
+    A->B: result
+```
+
+The third way `@return` is rarely used, but it is useful when you want to return to one level up.
+
+```mermaid-example
+zenuml
+    title Reply message
+    Client->A.method() {
+      B.method() {
+        if(condition) {
+          return x1
+          // return early
+          @return
+          A->Client: x11
+        }
+      }
+      return x2
+    }
+```
+
+```mermaid
+zenuml
+    title Reply message
+    Client->A.method() {
+      B.method() {
+        if(condition) {
+          return x1
+          // return early
+          @return
+          A->Client: x11
+        }
+      }
+      return x2
+    }
+```
+
+## Nesting
+
+Sync messages and Creation messages are naturally nestable with `{}`.
+
+```mermaid-example
+zenuml
+    A.method() {
+      B.nested_sync_method()
+      B->C: nested async message
+    }
+```
+
+```mermaid
+zenuml
+    A.method() {
+      B.nested_sync_method()
+      B->C: nested async message
+    }
+```
+
+## Comments
+
+It is possible to add comments to a sequence diagram with `// comment` syntax.
+Comments will be rendered above the messages or fragments. Comments on other places
+are ignored. Markdown is supported.
+
+See the example below:
+
+```mermaid-example
+zenuml
+    // a comment on a participant will not be rendered
+    BookService
+    // a comment on a message.
+    // **Markdown** is supported.
+    BookService.getBook()
+```
+
+```mermaid
+zenuml
+    // a comment on a participant will not be rendered
+    BookService
+    // a comment on a message.
+    // **Markdown** is supported.
+    BookService.getBook()
+```
+
+## Loops
+
+It is possible to express loops in a ZenUML diagram. This is done by any of the
+following notations:
+
+1. while
+2. for
+3. forEach, foreach
+4. loop
+
+```zenuml
+while(condition) {
+    ...statements...
+}
+```
+
+See the example below:
+
+```mermaid-example
+zenuml
+    Alice->John: Hello John, how are you?
+    while(true) {
+      John->Alice: Great!
+    }
+```
+
+```mermaid
+zenuml
+    Alice->John: Hello John, how are you?
+    while(true) {
+      John->Alice: Great!
+    }
+```
+
+## Alt
+
+It is possible to express alternative paths in a sequence diagram. This is done by the notation
+
+```zenuml
+if(condition1) {
+    ...statements...
+} else if(condition2) {
+    ...statements...
+} else {
+    ...statements...
+}
+```
+
+See the example below:
+
+```mermaid-example
+zenuml
+    Alice->Bob: Hello Bob, how are you?
+    if(is_sick) {
+      Bob->Alice: Not so good :(
+    } else {
+      Bob->Alice: Feeling fresh like a daisy
+    }
+```
+
+```mermaid
+zenuml
+    Alice->Bob: Hello Bob, how are you?
+    if(is_sick) {
+      Bob->Alice: Not so good :(
+    } else {
+      Bob->Alice: Feeling fresh like a daisy
+    }
+```
+
+## Opt
+
+It is possible to render an `opt` fragment. This is done by the notation
+
+```zenuml
+opt {
+  ...statements...
+}
+```
+
+See the example below:
+
+```mermaid-example
+zenuml
+    Alice->Bob: Hello Bob, how are you?
+    Bob->Alice: Not so good :(
+    opt {
+      Bob->Alice: Thanks for asking
+    }
+```
+
+```mermaid
+zenuml
+    Alice->Bob: Hello Bob, how are you?
+    Bob->Alice: Not so good :(
+    opt {
+      Bob->Alice: Thanks for asking
+    }
+```
+
+## Parallel
+
+It is possible to show actions that are happening in parallel.
+
+This is done by the notation
+
+```zenuml
+par {
+  statement1
+  statement2
+  statement3
+}
+```
+
+See the example below:
+
+```mermaid-example
+zenuml
+    par {
+        Alice->Bob: Hello guys!
+        Alice->John: Hello guys!
+    }
+```
+
+```mermaid
+zenuml
+    par {
+        Alice->Bob: Hello guys!
+        Alice->John: Hello guys!
+    }
+```
+
+## Try/Catch/Finally (Break)
+
+It is possible to indicate a stop of the sequence within the flow (usually used to model exceptions).
+
+This is done by the notation
+
+```
+try {
+  ...statements...
+} catch {
+  ...statements...
+} finally {
+  ...statements...
+}
+```
+
+See the example below:
+
+```mermaid-example
+zenuml
+    try {
+      Consumer->API: Book something
+      API->BookingService: Start booking process
+    } catch {
+      API->Consumer: show failure
+    } finally {
+      API->BookingService: rollback status
+    }
+```
+
+```mermaid
+zenuml
+    try {
+      Consumer->API: Book something
+      API->BookingService: Start booking process
+    } catch {
+      API->Consumer: show failure
+    } finally {
+      API->BookingService: rollback status
+    }
+```
+
+## Integrating with your library/website.
+
+Zenuml uses the experimental lazy loading & async rendering features which could change in the future.
+
+You can use this method to add mermaid including the zenuml diagram to a web page:
+
+```html
+<script type="module">
+  import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs';
+  import zenuml from 'https://cdn.jsdelivr.net/npm/@mermaid-js/mermaid-zenuml@0.1.0/dist/mermaid-zenuml.esm.min.mjs';
+  await mermaid.registerExternalDiagrams([zenuml]);
+</script>
+```

package/teams/fhr-neowise/skills/mermaid-diagram/scripts/sync_docs.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python3
+import os
+import re
+import shutil
+import subprocess
+
+SKILL_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+REFERENCES_DIR = os.path.join(SKILL_DIR, "references")
+SKILL_MD = os.path.join(SKILL_DIR, "SKILL.md")
+MERMAID_SOURCE = os.path.join(SKILL_DIR, "mermaid-source")
+
+CONFIG_FILES = [
+    "configuration.md",
+    "directives.md",
+    "layouts.md",
+    "math.md",
+    "theming.md",
+    "tidy-tree.md"
+]
+
+def run_cmd(cmd, cwd=None):
+    print(f"Running: {' '.join(cmd)}")
+    subprocess.run(cmd, cwd=cwd, check=True)
+
+def clone_mermaid():
+    if os.path.exists(MERMAID_SOURCE):
+        shutil.rmtree(MERMAID_SOURCE)
+    
+    os.makedirs(MERMAID_SOURCE)
+    
+    # Use sparse checkout for efficiency
+    run_cmd(["git", "clone", "--filter=blob:none", "--no-checkout", "--depth", "1", 
+             "https://github.com/mermaid-js/mermaid.git", MERMAID_SOURCE])
+    
+    run_cmd(["git", "sparse-checkout", "set", "docs/syntax", "docs/config"], cwd=MERMAID_SOURCE)
+    run_cmd(["git", "checkout", "develop"], cwd=MERMAID_SOURCE)
+
+def sync_references():
+    os.makedirs(REFERENCES_DIR, exist_ok=True)
+    
+    syntax_dir = os.path.join(MERMAID_SOURCE, "docs", "syntax")
+    config_dir = os.path.join(MERMAID_SOURCE, "docs", "config")
+    
+    new_syntax_files = []
+    
+    # Copy syntax files
+    if os.path.exists(syntax_dir):
+        for file in os.listdir(syntax_dir):
+            if file.endswith(".md"):
+                src = os.path.join(syntax_dir, file)
+                dst = os.path.join(REFERENCES_DIR, file)
+                shutil.copy2(src, dst)
+                new_syntax_files.append(file)
+                
+    # Copy config files
+    if os.path.exists(config_dir):
+        for file in CONFIG_FILES:
+            src = os.path.join(config_dir, file)
+            if os.path.exists(src):
+                dst = os.path.join(REFERENCES_DIR, f"config-{file}")
+                shutil.copy2(src, dst)
+                
+    return new_syntax_files
+
+def extract_title(md_path):
+    # Try to find the first level 1 heading
+    try:
+        with open(md_path, 'r', encoding='utf-8') as f:
+            for line in f:
+                if line.startswith("# "):
+                    return line[2:].strip()
+        # Fallback to filename
+        return os.path.basename(md_path).replace(".md", "").capitalize()
+    except Exception:
+        return os.path.basename(md_path).replace(".md", "").capitalize()
+
+def update_skill_md(new_syntax_files):
+    if not os.path.exists(SKILL_MD):
+        print(f"{SKILL_MD} not found!")
+        return
+        
+    with open(SKILL_MD, 'r', encoding='utf-8') as f:
+        content = f.read()
+        
+    # Find the table. We assume it's the one starting with "| Type"
+    table_pattern = re.compile(r'(\| Type\s*\| Documentation\s*\| Use Cases\s*\|.*?)\n\n', re.DOTALL)
+    match = table_pattern.search(content)
+    
+    if not match:
+        print("Could not find the diagram types table in SKILL.md")
+        return
+        
+    table_block = match.group(1)
+    
+    # Extract existing referenced files
+    existing_files = set(re.findall(r'\[.*?\]\(references/(.*?)\)', table_block))
+    
+    new_rows = []
+    for file in sorted(new_syntax_files):
+        if file not in existing_files and file != "README.md" and file != "examples.md":
+            title = extract_title(os.path.join(REFERENCES_DIR, file))
+            # Fallback title if it's super long or has weird characters
+            if len(title) > 30:
+                title = file.replace(".md", "").capitalize()
+            
+            # Format row
+            row = f"| {title} | [{file}](references/{file}) | Auto-synced from upstream |"
+            new_rows.append(row)
+            print(f"Adding new diagram type to table: {file}")
+            
+    if new_rows:
+        updated_table = table_block + "\n" + "\n".join(new_rows)
+        new_content = content.replace(table_block, updated_table)
+        
+        with open(SKILL_MD, 'w', encoding='utf-8') as f:
+            f.write(new_content)
+        print("SKILL.md updated successfully.")
+    else:
+        print("No new diagram types found to add.")
+
+def main():
+    print("Cloning Mermaid repository (sparse checkout)...")
+    clone_mermaid()
+    
+    print("Syncing markdown references...")
+    new_syntax_files = sync_references()
+    
+    print("Updating SKILL.md...")
+    update_skill_md(new_syntax_files)
+    
+    print("Cleaning up...")
+    if os.path.exists(MERMAID_SOURCE):
+        shutil.rmtree(MERMAID_SOURCE)
+        
+    print("Done!")
+
+if __name__ == "__main__":
+    main()

package/teams/fhr-neowise/skills/pull-request-authoring/COMPLEX.template.md

@@ -0,0 +1,52 @@
+<!-- Title: FHR-<number>: <Ticket Title> -->
+
+## Summary
+
+<1–3 sentences: what this change does and why it is needed. Reference the ticket: FHR-<number>.>
+
+## What Changed
+
+<The substantive changes, grouped by module/area when the PR spans several.>
+- **<module>**: <change>
+- **<module>**: <change>
+
+## Flow / Behaviour Changes
+
+<Mermaid diagram showing how the flow or behaviour changes — prefer before → after.
+ Use a flowchart for control/data flow, or a sequenceDiagram for cross-service interaction.
+ Generated with the `mermaid-diagram` skill. Delete this section only if no flow/behaviour changed.>
+
+```mermaid
+<diagram>
+```
+
+## Structure / Class Changes
+
+<Mermaid classDiagram of new/changed classes, types, and their relationships.
+ Generated with the `mermaid-diagram` skill. Delete this section only if no types/structure changed.>
+
+```mermaid
+<diagram>
+```
+
+<!-- A complex PR must keep at least one of the two diagram sections above; delete the section that does not apply. -->
+
+## Impacted Areas
+
+<Modules, files, and contracts touched, plus downstream consumers affected
+ (APIs, GraphQL fields, SQL/Delta tables, dashboard components, schedulers).>
+- <area / contract>
+- <downstream consumer>
+
+## Testing
+
+<How the change is verified: unit/integration tests added or updated, plus any manual checks.>
+- <test>
+
+## Risk & Rollout
+
+<Blast radius, backward-compatibility, data migrations, feature flags, and rollback plan.>
+
+## Reviewer Notes
+
+<Suggested review order, anything non-obvious, and decisions reviewers should sanity-check.>

package/teams/fhr-neowise/skills/pull-request-authoring/NON-CODE.template.md

@@ -0,0 +1,15 @@
+<!-- Title: FHR-<number>: <Ticket Title> -->
+
+## Summary
+
+<One line: what this non-code change covers (docs, config, tooling). Reference the ticket: FHR-<number>.>
+
+## Changes
+
+- <change>
+- <change>
+- <change>
+
+## Impact
+
+<One line confirming scope, e.g. "Docs/config only — no production code, tests, or dependency versions changed.">

package/teams/fhr-neowise/skills/pull-request-authoring/SIMPLE.template.md

@@ -0,0 +1,20 @@
+<!-- Title: FHR-<number>: <Ticket Title> -->
+
+## Summary
+
+<1–2 sentences: what changed and why. Reference the ticket: FHR-<number>.>
+
+## Change
+
+<A short description of what was done. For a bugfix, name the root cause and the fix.>
+
+## Impacted Areas
+
+<The places this change touched — files, methods, and the module(s) affected.>
+- <path / method>
+- <module>
+
+## Testing
+
+<Tests added or run, and the result.>
+- <test>