Skip to content

Change Requests

We welcome ideas for new features, enhancements, or workflow improvements. Before you file a change request, please read this guide so we can evaluate and prioritize your proposal effectively.

Before Submitting

Please do the following preliminary work to ensure your idea fits VerifIA’s scope and philosophy:

  1. Not a bug
    Change requests are for new features or behavior changes, not bug reports. If you’ve found a bug, see our bug report guide.

  2. Gather inspiration
    If you’ve seen this feature in another tool or library, collect links or examples. Explaining what you like helps us assess fit quickly.

Issue Template

When you’re ready, open a new issue with the following sections:

  • Title
  • Context (optional)
  • Description
  • Related links
  • Use cases
  • Visuals (optional)
  • Checklist

Title

A concise, one‑sentence summary. Include keywords for easy search.

Example
✔️ Clear “Add support for custom seed sampling strategies”
❌ Unclear “Improve sampling”
❌ Useless “Feature request”

Context (optional)

Brief environment or project details. For example:

Using VerifIA v1.2.0 in a robotics QA workflow with domain YAML files defining kinematic constraints.

Why

Some features only make sense in specific contexts or use cases.

Description

Explain what you propose, not why (use cases cover that). Be precise and concise.

  • One idea per request.
  • Keep it to a few sentences.

Link to any relevant issues, docs pages, or external examples. This helps us understand existing discussions or implementations.

Use cases

Describe how authors or users would leverage this change:

  • Expected workflow impact
  • Who benefits and why
  • Potential backward‑compatibility concerns

Why

Clear use cases help us prioritize high‑value enhancements.

Visuals (optional)

Drop in mockups, diagrams, or screenshots if they clarify your idea. You can attach files or link to external assets.

Checklist

Before submitting, confirm:

  • I searched existing issues and docs
  • Title is clear and descriptive
  • Description precisely outlines the proposal
  • Related links provided
  • Use cases explained
  • Visuals attached (if applicable)

Rejected Requests

If your request is declined, don’t be discouraged! We balance many factors:

  • Alignment with VerifIA’s vision
  • Compatibility and maintenance effort
  • Benefit to the broader community
  • Simplicity and usability

Feel free to ask for clarification if you’re unsure why a proposal wasn’t accepted.

Thank you for helping shape VerifIA’s future! 🎯