feat : contribution baseline (#6)

* docs : pre-commit init

* chore: ruff all file

* chore: change ruff config

* chore: change ruff config

* docs: PR Template update

* fix : uv.lock fix

* docs : contributing documentation

Author: halucinor

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Overview
+<!-- Provide a brief description of what this PR does -->
+
+## Key Changes
+<!-- List the main changes made in this PR -->
+- 
+- 
+
+## Related Issues
+<!-- Link to related issues using "Fixes #123", "Closes #456", or "Relates to #789" -->
+- 
+
+## Additional context
+<!-- Any additional information that reviewers should know -->

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.12.7
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format

CONTRIBUTING.rst

@@ -0,0 +1,91 @@
+==============================
+Contributing to OpenStack MCP Server
+==============================
+
+About the Project
+==================
+
+OpenStack MCP Server is a project that integrates various OpenStack functionalities with the Model Context Protocol (MCP), enabling LLM-powered management of OpenStack resources.
+
+How to Contribute
+=================
+
+First, thank you for reading this document to contribute to our OpenStack MCP Server project. The following content explains the guidelines for contributing to our project, how to set up the development environment, and coding style guidelines.
+
+PR Guidelines
+=============
+
+Issue Report
+------------
+
+Before submitting code for new features (and this also applies to some complex bug fixes), please first raise a **Feature request** or **Bug report**.
+
+Review Process
+--------------
+
+- This project currently uses main and develop branches as the base. PRs to the main branch are restricted to the develop branch.
+- All patches must be first merged into the develop branch and require approval from at least 2 code reviewers to be merged into develop.
+
+Commit Message
+--------------
+
+We use the `Conventional Commits <https://www.conventionalcommits.org/en/v1.0.0/>`_ convention for writing commit messages.
+
+Format::
+
+    <type>[optional scope]: <description>
+    [optional body]
+    [optional footer(s)]
+
+**Example**::
+
+    feat(nova): implement server management tools
+
+    Add Nova server listing and detail retrieval functionality
+    for MCP clients with proper error handling and OpenStack SDK integration.
+
+    - Add get_nova_servers tool
+    - Add get_server_details tool  
+    - Implement server status filtering
+    - Add comprehensive error handling
+
+    Closes #123
+
+Development Environment
+=======================
+
+The following content is a guide for contributors to set up a development environment in their local environment.
+
+Prerequisites
+=============
+
+- This project uses uv to manage Python packages. Please set up an environment where you can use uv in your local environment for development environment setup. `Reference <https://docs.astral.sh/uv/getting-started/installation/>`_
+- We use ``python3.10`` as the default version. This is to ensure compatibility with other OpenStack projects.
+
+UV Package Build
+----------------
+
+.. code-block:: bash
+
+    uv sync --all-groups
+
+Pre-commit
+----------
+
+Code style is managed uniformly through ruff. We recommend setting up pre-commit hooks so that auto-formatting is applied at the commit stage.
+
+.. code-block:: bash
+
+    pre-commit install
+
+Testing
+=======
+
+Unit Tests
+----------
+
+All patches related to feature additions must implement unit test code. This project uses Pytest as the testing library, and if the project has been built successfully, you can run tests with the following command:
+
+.. code-block:: bash
+
+    uv run pytest

pyproject.toml

@@ -8,10 +8,13 @@ dependencies = [
     "mcp[cli]>=1.12.0",
     "openstacksdk>=4.6.0",
     "pydantic>=2.11.7",
-    "ruff>=0.12.5",
 ]
 
 [dependency-groups]
+dev = [
+    "ruff>=0.12.5",
+    "pre-commit>=4.2.0",
+]
 test = [
     "pytest>=8.4.1",
 ]
@@ -34,6 +37,10 @@ python_functions = ["test_*"]
 
 [tool.ruff]
 line-length = 79
+exclude = [
+    "tests",
+    "docs",
+]
 
 [tool.ruff.format]
 quote-style = "double"

src/openstack_mcp_server/__init__.py

@@ -8,7 +8,7 @@
 logging.basicConfig(
     level=logging.INFO,
     format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
-    handlers=[logging.StreamHandler(sys.stderr)]
+    handlers=[logging.StreamHandler(sys.stderr)],
 )
 logger = logging.getLogger("openstack-mcp-server")
 
@@ -25,6 +25,7 @@ def main():
         # Import here to avoid circular imports
         from openstack_mcp_server.config import MCP_TRANSPORT
         from openstack_mcp_server.server import serve
+
         parser = argparse.ArgumentParser(
             description="Openstack MCP Server",
         )
@@ -36,13 +37,16 @@ def main():
         # Validate transport protocol
         if MCP_TRANSPORT not in ["stdio", "sse", "streamable-http"]:
             logger.error(
-                f"Invalid transport protocol: {MCP_TRANSPORT}. Using stdio instead.")
+                f"Invalid transport protocol: {MCP_TRANSPORT}. Using stdio instead."
+            )
             transport = "stdio"
         else:
             transport = MCP_TRANSPORT
 
         # Start the server
-        logger.info(f"Starting Openstack MCP Server with {transport} transport")
+        logger.info(
+            f"Starting Openstack MCP Server with {transport} transport"
+        )
 
         args = parser.parse_args()
 

src/openstack_mcp_server/__main__.py

@@ -1,4 +1,4 @@
 from openstack_mcp_server import main
 
 
-main()
+main()

src/openstack_mcp_server/config.py

@@ -6,4 +6,4 @@
 MCP_TRANSPORT = os.environ.get("TRANSPORT", "stdio")
 
 # Application paths
-BASE_DIR = Path(__file__).parent.parent.parent
+BASE_DIR = Path(__file__).parent.parent.parent

src/openstack_mcp_server/tools/__init__.py

@@ -1,10 +1,10 @@
 from mcp.server.fastmcp import FastMCP
 
 
-def register_tool(mcp : FastMCP):
+def register_tool(mcp: FastMCP):
     """
     Register Openstack MCP tools.
     """
     from .nova_tools import NovaTools
 
-    NovaTools().register_tools(mcp)
+    NovaTools().register_tools(mcp)

src/openstack_mcp_server/tools/nova_tools.py

@@ -21,21 +21,22 @@ def register_tools(self, mcp: FastMCP):
 
     def get_nova_servers(self) -> str:
         """
-            Get the list of Nova servers by invoking the registered tool.
+        Get the list of Nova servers by invoking the registered tool.
 
-            :return: A string containing the names, IDs, and statuses of the servers.
-            """
+        :return: A string containing the names, IDs, and statuses of the servers.
+        """
 
         # Initialize and turn on debug logging
         openstack.enable_logging(debug=True)
 
         # Initialize connection
-        conn = openstack.connect(cloud='openstack')
+        conn = openstack.connect(cloud="openstack")
 
         # List the servers
         server_list = []
         for server in conn.list_servers():
             server_list.append(
-                f"{server.name} ({server.id}) - Status: {server.status}")
+                f"{server.name} ({server.id}) - Status: {server.status}"
+            )
 
         return "\n".join(server_list)

tests/conftest.py

@@ -5,34 +5,45 @@
 @pytest.fixture
 def mock_openstack_logging():
     """Mock openstack.enable_logging function."""
-    with patch('openstack_mcp_server.tools.nova_tools.openstack.enable_logging') as mock:
+    with patch(
+        "openstack_mcp_server.tools.nova_tools.openstack.enable_logging"
+    ) as mock:
         yield mock
 
 
 @pytest.fixture
 def mock_openstack_connect():
     """Mock openstack.connect function."""
-    with patch('openstack_mcp_server.tools.nova_tools.openstack.connect') as mock:
+    with patch(
+        "openstack_mcp_server.tools.nova_tools.openstack.connect"
+    ) as mock:
         yield mock
 
 
 @pytest.fixture
 def mock_openstack_connection():
     """Mock openstack connection object."""
     mock_conn = Mock()
-    with patch('openstack_mcp_server.tools.nova_tools.openstack.connect', return_value=mock_conn) as mock_connect:
+    with patch(
+        "openstack_mcp_server.tools.nova_tools.openstack.connect",
+        return_value=mock_conn,
+    ) as mock_connect:
         yield mock_conn, mock_connect
 
 
 @pytest.fixture
 def mock_server():
     """Create a mock server object."""
-    def _create_server(name="test-server", server_id="test-id", status="ACTIVE"):
+
+    def _create_server(
+        name="test-server", server_id="test-id", status="ACTIVE"
+    ):
         mock = Mock()
         mock.name = name
         mock.id = server_id
         mock.status = status
         return mock
+
     return _create_server
 
 
@@ -41,11 +52,11 @@ def sample_servers(mock_server):
     """Create sample server list."""
     return [
         mock_server("server1", "id1", "ACTIVE"),
-        mock_server("server2", "id2", "STOPPED")
+        mock_server("server2", "id2", "STOPPED"),
     ]
 
 
 @pytest.fixture
 def mock_fastmcp():
     """Mock FastMCP instance."""
-    return Mock()
+    return Mock()