mirror of
https://github.com/MAKS-IT-COM/maksit-gitea-cursor.git
synced 2026-09-29 20:48:10 +02:00
40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
## Local development
|
|
|
|
Requires Node 18+.
|
|
|
|
```bash
|
|
cd server
|
|
npm install
|
|
npm test
|
|
npm run build
|
|
node ../scripts/validate-plugin.mjs
|
|
```
|
|
|
|
Load the plugin in Cursor:
|
|
|
|
1. Symlink this repo to `~/.cursor/plugins/local/maksit-gitea-cursor`
|
|
2. Reload the window
|
|
3. Set `GITEA_URL` and `GITEA_TOKEN` on the plugin
|
|
|
|
Windows PowerShell:
|
|
|
|
```powershell
|
|
New-Item -ItemType Junction -Path "$env:USERPROFILE\.cursor\plugins\local\maksit-gitea-cursor" -Target "<path-to-this-repo>"
|
|
```
|
|
|
|
## Before a public release
|
|
|
|
1. Confirm this tree is on [MAKS-IT-COM/maksit-gitea-cursor](https://github.com/MAKS-IT-COM/maksit-gitea-cursor) (Cursor resolves plugin logos via `raw.githubusercontent.com`).
|
|
2. Confirm `homepage`, `repository`, and `author.email` in `.cursor-plugin/plugin.json`.
|
|
3. Confirm `server/dist/index.js` is built and committed (source maps are gitignored).
|
|
4. Run `npm test`, `npm run build`, and `node scripts/validate-plugin.mjs`.
|
|
5. Submit at [cursor.com/marketplace/publish](https://cursor.com/marketplace/publish). Official listing is curated; also consider [cursor.directory](https://cursor.directory).
|
|
|
|
Keep examples generic (`https://git.example.com`). Do not commit instance hostnames, tokens, or local user paths.
|
|
|
|
## License
|
|
|
|
Contributions are accepted under Apache-2.0.
|