Contributing to VerifIA

VerifIA is an open‑source project under active development. Your contributions—whether reporting bugs, improving documentation, suggesting features, or submitting pull requests—help us make the tool more robust, user‑friendly, and aligned with real‑world workflows.

Our community thrives when contributions are well‑structured, clear, and easy to review. This guide will help you pick the right path and template for your contribution.

How You Can Contribute

1. Report a Bug

Found unexpected behavior or an error in VerifIA? Please help us by following the bug report guide.

2. Report a Docs Issue

Spotted a typo, inconsistency, or missing detail in the documentation? Open a docs issue so we can clarify or expand the docs.

3. Request a Change

Have an idea for a new feature or enhancement? Share your proposal via a change request issue.

4. Create a Pull Request

Ready to contribute code or docs? See our pull request instructions to learn how to fork, branch, and submit a PR.

Before You File an Issue

Please take a moment to:

🔍 Search existing issues to avoid duplicates.
📦 Update to the latest VerifIA version—your issue may already be fixed.
📝 Choose the appropriate template (bug, docs, change request) when opening a new issue.
🧩 Provide all necessary details (steps to reproduce, minimal example, environment) so we can triage quickly.

Issues are permanent

All issues and comments are publicly visible and stored long‑term. Please be respectful, constructive, and follow our Code of Conduct.

Pull Request Workflow

Fork the repository and clone your fork locally.
Create a branch for your work (feature/..., bugfix/..., docs/...).
Commit small, focused changes with clear messages.
Push to your fork and open a draft PR early—reference the related issue.
Sync with upstream/main regularly to avoid merge conflicts.
Mark as ready when your PR is complete and request a review.

For full details and examples, see [making a pull request].

Checklist

Before submitting, please confirm:

I’ve selected the correct issue template or PR workflow.
I searched existing issues and docs for related discussions.
I provided a clear title and description.
I included minimal, reproducible examples (if filing a bug).
I linked to related issues or documentation pages.
My changes follow the project’s style and conventions.

Code of Conduct

Our Code of Conduct outlines the expectation for all community members to treat one another with respect, employing inclusive and welcoming language. Our commitment is to foster a positive and supportive environment, free of inappropriate, offensive, or harmful behavior.

We take any violations seriously and will take appropriate action in response to uphold these values.

Warning and Blocking Policy: To maintain a respectful and constructive community as VerifIA grows, we follow a three‑step process for handling serious or repeated misconduct:

First Warning Users exhibiting inappropriate, offensive, or harmful behavior receive a formal notice that their actions violate our Code of Conduct. This warning is recorded permanently.
Second Warning & Resolution Period If the behavior continues, a second warning is issued. The user then has five days to reflect and, if they choose, publicly address or apologize for their conduct. This period offers a chance to clear up misunderstandings.
Blocking If no improvement or response occurs after five days, we may block the user from our community and repository. This step is a last resort, taken only when necessary to protect our community’s integrity.

Blocking remains extremely rare in our positive environment, underscoring our commitment to dialogue, respect, and mutual support.

Thank you for helping improve VerifIA ! We look forward to your contributions.