Skip to content

Commit b5ef111

Browse files
committed
Update contributing
1 parent 04f9fe5 commit b5ef111

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ Contributions to OpenZeppelin Contracts Wizard are welcome. Please review the in
55

66
## Project layout
77

8+
- `packages/common` contains common code used internally by some of the below packages.
89
- `packages/core` contains the code generation logic for each language under separately named subfolders.
10+
- `packages/mcp` contains the MCP server.
911
- `packages/ui` is the interface built in Svelte.
1012

1113
## Building and testing the project
@@ -65,6 +67,29 @@ Then from the `packages/ui` directory:
6567
> [!TIP]
6668
> You can also start both the UI and API servers simultaneously by running `yarn dev` from the root directory.
6769
70+
### Testing the MCP server (Optional)
71+
72+
#### Running MCP tests
73+
From the `packages/mcp` directory:
74+
- ```yarn test```
75+
76+
#### Running the local MCP server in your IDE
77+
1. From the `packages/mcp` directory, run `yarn watch` to compile and watch for changes.
78+
2. Configure your IDE's MCP configuration file with the following, replacing `<ABSOLUTE_PATH_TO_WIZARD_PROJECT_ROOT>` with the absolute path to the root directory of this repository:
79+
```
80+
{
81+
"mcpServers": {
82+
"openzeppelin-contracts-wizard": {
83+
"command": "node",
84+
"args": [
85+
"<ABSOLUTE_PATH_TO_WIZARD_PROJECT_ROOT>/packages/mcp/dist/index.js"
86+
]
87+
}
88+
}
89+
}
90+
```
91+
3. When you make changes to the MCP server's code, refresh the MCP server in your IDE to pick up the changes.
92+
6893
## Creating Pull Requests (PRs)
6994

7095
As a contributor, we ask that you fork this repository, work on your own fork and then submit pull requests. The pull requests will be reviewed and eventually merged into the main repo. See ["Fork-a-Repo"](https://help.github.com/articles/fork-a-repo/) for how this works.

0 commit comments

Comments
 (0)