Opening a GitLab issue

When something in Jane behaves unexpectedly, the fastest way to get help is to open an issue in the GitLab repository.

Steps

• Go to your project’s GitLab repository.
• Select Issues and then New issue.
• Choose the appropriate template (Bug, Feature Request, or Documentation).
• Provide:
• A clear title.
• A minimal reproduction (if applicable).
• Expected vs. actual behavior.
• Jane version and Node version.
• Any relevant logs or events.
• Submit the issue.

Tips

• Reproductions should be as small as possible.
• Include the boundary, field definitions, and any custom rules.
• If the issue involves events, paste the event list exactly as emitted.

Reporting a parsing or validation bug

If a parser or validator behaves incorrectly:

• Capture the normalized value, parsed value, and events.
• Note which parser or validator was used.
• Open a GitLab issue with:
• The exact input
• The expected output
• The actual output
• The event stream
• If the issue is intermittent, include multiple runs.

Requesting a new parser or boundary rule

If Jane is missing a parser or rule you need:

• Open a Feature Request issue.
• Describe:
• The real‑world use case
• The expected behavior
• Any edge cases
• Include examples of:
• Valid input
• Invalid input
• Expected events
• If you have a prototype, link to it.

Troubleshooting unexpected boundary rejections

If a boundary is rejected and you’re not sure why:

• Enable event visibility (if using a strict policy).
• Re‑run the boundary with .scan(), .withDiff(), and withExplain() for debugging.
• Inspect:
• Field decisions
• Boundary issues
• Event codes
• If the issue persists, open a GitLab issue with:
• The boundary definition
• The input
• The event stream
• The policy used

When to use strict vs. lax policies

• strictPolicy: Use when input is untrusted or correctness is critical.
• defaultPolicy: Use during development or when you want predictable, transparent behavior.
• laxPolicy: Use when experimenting or debugging field‑level behavior without boundary interference.

Getting help with custom rules

If you’re writing a custom parser, validator, or boundary rule:

• Start with a minimal reproduction.
• Include:
• The rule implementation
• The boundary definition
• The input
• The event stream
• Open a GitLab issue under Support, and then Custom Rules.