Skip to content

Commit c5d19ac

Browse files
committed
docs(CONTRIBUTING): Document development setup
1 parent ae196de commit c5d19ac

1 file changed

Lines changed: 23 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,12 @@
22

33
## Content
44

5+
1. [📝 **Reporting Issues**](#-reporting-issues)
56
1. [📝 **Reporting Issues**](#-reporting-issues)
67
2. [🤩 **Feature Requests**](#-feature-requests)
78
3. [🔍 **Analyzing Issues**](#-analyzing-issues)
89
4. [💻 **Contributing Code**](#-contributing-code)
910

10-
### ⚡️ Quick Links for Maintainers
11-
12-
- [All Open Pull Requests](https://github.com/UI5/mcp-server/pulls)
13-
- [All Open Issues](https://github.com/UI5/mcp-server/issues)
14-
1511
## 📝 Reporting Issues
1612

1713
### Seeking Help / Not a Bug
@@ -96,6 +92,28 @@ You may be able to add additional or missing information, such as a step-by-step
9692

9793
## 💻 Contributing Code
9894

95+
### Development Setup
96+
97+
1. Clone the repository: `git clone git@github.com:UI5/linter.git ui5-linter`
98+
2. Navigate to the repository and install dependencies: `cd ui5-linter && npm install`
99+
3. Build the server: `npm run build`
100+
* While developing, you may use `npm run build-watch` to automatically rebuild the server on code changes. Make sure to restart the server in your MCP client to get your changes!
101+
4. Link it globally: `npm link` - this makes the `ui5mcp` command available globally
102+
103+
In your MCP client, use the following configuration to reference the local server:
104+
105+
```json
106+
{
107+
"mcpServers": {
108+
"ui5mcp": {
109+
"type": "stdio",
110+
"command": "ui5mcp",
111+
"args": []
112+
}
113+
}
114+
}
115+
```
116+
99117
### General Remarks
100118

101119
You are welcome to contribute code to UI5 MCP server in order to fix bugs or to implement new features.

0 commit comments

Comments
 (0)