Coding Agent Context

This project uses uv for dependency management and enforces strict linting, formatting, and type-checking standards. All Coding Agents MUST follow these instructions after generating or modifying code to ensure compatibility with the project's CI/CD pipelines.

Post-Generation Checklist

From the repository root (where this AGENTS.md file lives), run the following commands inside the v3/ directory:

1. Code Formatting: Format the code using ruff.

   uv run ruff format .
   

2. Linting: Run ruff check to identify and fix potential issues.

   uv run ruff check --fix .
   

3. Type Checking: Verify type safety with mypy.

   uv run mypy --ignore-missing-imports .
   

Development Standards

• Language: All code, documentation, and comments MUST be written in English.
• Dependencies: Use uv for all dependency management tasks (e.g., uv sync, uv run).
• CI Alignment: These steps align with the .github/workflows/linting.yml and .github/workflows/type-tests.yml configurations.

Ensure all checks pass before considering a task complete.

Welcome to Apache Steve http://steve.apache.org/

Apache Steve is software to conduct a vote using the STV (Single Transferable Vote) and other voting algorithms. The tool grew out of the voting system used to elect the Apache Software Foundation Board of Directors.

Read more about STV at http://en.wikipedia.org/wiki/Single_transferable_vote

[!NOTE]

The v3 directory contains the current (ongoing) version of Steve. Read the v3/README.md file for more information about this version. Read the Getting Started Guide to set up a development environment for v3.

Getting Started

Getting Started documentation can be found at: http://steve.apache.org/demo.html Otherwise, come to the #steve channel on the Slack workspace at the-asf.slack.com, and we'd be glad to help you.

Documentation

Documentation may be found at http://steve.apache.org/documentation.html

Contributions to the documentation are very welcome.

Mailing Lists

Discussion about Steve takes place on the following mailing lists:

dev@steve.apache.org    - About using Steve and developing Steve

Notification on all code changes are sent to the following mailing list:

commits@steve.apache.org

The mailing lists are open to anyone and publicly archived.

You can subscribe the mailing lists by sending a message to <LIST>-subscribe@steve.apache.org (for example dev-subscribe@steve.apache.org). To unsubscribe, send a message to <LIST>-unsubscribe@steve.apache.org. For more instructions, send a message to <LIST>-help@steve.apache.org.

Issue Tracker

If you encounter errors in Steve or want to suggest an improvement or a new feature, please visit the Steve issue tracker at https://github.com/apache/steve/issues