.. _ref_contributing:

============
Contributing
============

You can contribute to PyMAPDL-MCP in several ways.

* `Answer discussions`_
* `Post issues`_
* :ref:`ref_write_documentation` (described on its own page)
* :ref:`ref_develop_pymapdl_mcp` (described on its own page)

Before contributing to PyMAPDL-MCP, read
`Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_
and `Coding style <https://dev.docs.pyansys.com/coding-style/index.html>`_ in the
*PyAnsys developer's guide*. To generate useful release notes, follow the
guidelines in `Branch-naming conventions <https://dev.docs.pyansys.com/how-to/contributing.html#branch-naming-conventions>`_
and `Commit-naming conventions <https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions>`_.


Answer discussions
==================

Answering discussions is an excellent way to contribute to PyMAPDL-MCP 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 `PyMAPDL-MCP Discussions <https://github.com/ansys/pymapdl-mcp/discussions>`_ page.


Post issues
===========

Use the `PyMAPDL-MCP Issues <https://github.com/ansys/pymapdl-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 <https://github.com/ansys/pymapdl-mcp/issues/new>`_.

.. _ref_contributing_next_steps:

Next steps
==========

- To improve the documentation, see :ref:`write_documentation`.
- To contribute code, see :ref:`ref_develop_pymapdl_mcp`.