Skip to content

Commit dfa81fe

Browse files
authored
Update CONTRIBUTING.md
1 parent 906ef4a commit dfa81fe

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
## Contributing
1+
# Contributing
22

33
Contributions are welcome! Here's how you can help improve XcodeBuildMCP.
44

5-
### Local development setup
5+
## Local development setup
66

7-
#### Prerequisites
7+
### Prerequisites
88

9-
In addition to the prerequisites mentioned in the [Getting started](#getting-started) section, you will also need:
9+
In addition to the prerequisites mentioned in the [Getting started](README.md/#getting-started) section of the README, you will also need:
1010

1111
- Node.js (v16 or later)
1212
- npm
1313

14-
##### Optional: Enabling UI Automation
14+
#### Optional: Enabling UI Automation
1515

1616
When running locally, you'll need to install Facebook's idb tools:
1717

@@ -27,7 +27,7 @@ Install fb-idb Python package:
2727
pip install fb-idb==1.1.7
2828
```
2929

30-
#### Installation
30+
### Installation
3131

3232
1. Clone the repository
3333
2. Install dependencies:
@@ -43,7 +43,7 @@ pip install fb-idb==1.1.7
4343
node build/index.js
4444
```
4545

46-
#### Configure your MCP client
46+
### Configure your MCP client
4747

4848
To configure your MCP client to use your local XcodeBuildMCP server you can use the following configuration:
4949

@@ -60,27 +60,27 @@ To configure your MCP client to use your local XcodeBuildMCP server you can use
6060
}
6161
```
6262

63-
#### Debugging
63+
### Debugging
6464

6565
You can use MCP Inspector via:
6666

6767
```bash
6868
npx @modelcontextprotocol/inspector node build/index.js
6969
```
7070

71-
### Making changes
71+
## Making changes
7272

7373
1. Fork the repository and create a new branch
7474
2. Follow the TypeScript best practices and existing code style
7575
3. Add proper parameter validation and error handling
7676

77-
### Testing
77+
## Testing
7878

7979
1. Build the project with `npm run build`
8080
2. Test your changes with MCP Inspector
8181
3. Verify tools work correctly with different MCP clients
8282

83-
### Submitting
83+
## Submitting
8484

8585
1. Run `npm run lint` to check for linting issues (use `npm run lint:fix` to auto-fix)
8686
2. Run `npm run format:check` to verify formatting (use `npm run format` to fix)
@@ -90,3 +90,7 @@ npx @modelcontextprotocol/inspector node build/index.js
9090
6. Link any related issues
9191

9292
For major changes or new features, please open an issue first to discuss your proposed changes.
93+
94+
## Code of Conduct
95+
96+
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md) and community guidelines.

0 commit comments

Comments
 (0)