mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-07 22:24:06 -05:00
chore: update CONTRIBUTING.md
This commit is contained in:
6
.github/CONTRIBUTING.md
vendored
6
.github/CONTRIBUTING.md
vendored
@@ -411,6 +411,12 @@ In addition, you will need to update the registries:
|
||||
7. **Test Your Tool:**
|
||||
Ensure that your tool functions correctly by making test requests and verifying the responses.
|
||||
|
||||
8. **Generate Documentation:**
|
||||
Run the documentation generator to create docs for your new tool:
|
||||
```bash
|
||||
./scripts/generate-docs.sh
|
||||
```
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
Maintaining consistent naming across the codebase is critical for auto-generation of tools and documentation. Follow these naming guidelines:
|
||||
|
||||
@@ -45,6 +45,7 @@
|
||||
"lint-staged": {
|
||||
"*.{js,jsx,ts,tsx,json,css,scss,md}": [
|
||||
"biome check --files-ignore-unknown=true"
|
||||
]
|
||||
],
|
||||
"!.github/*.md": []
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user