Contribute#

You can contribute to PyMechanical-MCP in several ways:

  • Answer discussions

  • Post issues

  • Contribute code or documentation

Before contributing, read Contributing and Coding style in the PyAnsys developer’s guide. To generate useful release notes, follow the guidelines in Branch-naming conventions and Commit-naming conventions.

Answer discussions#

Answering discussions is an excellent way to contribute without any setup. Only a GitHub account is required. Engaging with discussions deepens your understanding of the project and helps other users facing similar issues, making the repository more welcoming and inclusive.

To see where you can help, visit the PyMechanical-MCP Discussions page.

Post issues#

Use the PyMechanical-MCP Issues page to report bugs, suggest improvements, and request features.

When possible, use these issue templates:

  • 🐞 Bug, problem, or error: File a bug report.

  • 📖 Documentation issue: Suggest modifications needed to the documentation.

  • 🎓 Adding an example: Propose a new example for the library.

  • 💡 New feature: Propose a new feature for the library.

If your issue does not fit into any existing category, click Blank issue.

Contribute code or documentation#

  1. Clone and install in editable mode with development dependencies:

    git clone https://github.com/ansys/pymechanical-mcp.git
cd pymechanical-mcp
pip install -e ".[dev]"
pre-commit install

  2. Run tests:

    # Fast unit tests (default CI matrix path)
pytest -m "not integration"

# Integration tests (requires Mechanical)
pytest -m integration

  3. Run linters:

    pre-commit run --all-files

  4. Build documentation:

    python -m sphinx -W -b html doc/source doc/_build/html

Next steps#