Skip to content

Commit 36e3c3e

Browse files
author
timhauke
committed
Initial Commit -> Version 1.0.0
1 parent 13c6bf0 commit 36e3c3e

39 files changed

+3127
-1
lines changed

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: [VectoDE]
2+
custom: ["https://www.uplytech.de"]

‎.github/instructions/codacy.instructions.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
description: Configuration for AI behavior when interacting with Codacy's MCP Server
3+
applyTo: '**'
4+
---
5+
---
6+
# Codacy Rules
7+
Configuration for AI behavior when interacting with Codacy's MCP Server
8+
9+
## CRITICAL: After ANY successful `edit_file` or `reapply` operation
10+
- YOU MUST IMMEDIATELY run the `codacy_cli_analyze` tool from Codacy's MCP Server for each file that was edited, with:
11+
- `rootPath`: set to the workspace path
12+
- `file`: set to the path of the edited file
13+
- `tool`: leave empty or unset
14+
- If any issues are found in the new edits, propose and apply fixes for them.
15+
- > NOTE: Failure to follow this rule is considered a critical error.
16+
17+
## When you tried to run the `codacy_cli_analyze` tool and the Codacy CLI is not installed
18+
- Ask the user 'Codacy CLI is not installed. Would you like me to install it now?'
19+
- If the user responds with "yes", run the `codacy_cli_install` tool and then continue with the original task
20+
- If the user responds with "no", instruct the user that they can disable automatic analysis in the extension settings
21+
- Wait for the user to respond before proceeding with any other actions
22+
23+
## After every response
24+
- If you made any file edits in this conversation, verify you ran `codacy_cli_analyze` tool from Codacy's MCP Server
25+
26+
## When there are no Codacy MCP Server tools available, or the MCP Server is not reachable
27+
- Suggest the user the following troubleshooting steps:
28+
- Try to reset the MCP on the extension
29+
- If the user is using VSCode, suggest them to review their Copilot > MCP settings in Github, under their organization or personal account. Refer them to Settings > Copilot > Enable MCP servers in Copilot. Suggested URL (https://github.com/settings/copilot/features) or https://github.com/organizations/{organization-name}/settings/copilot/features (This can only be done by their organization admins / owners)
30+
- If none of the above steps work, suggest the user to contact Codacy support
31+
32+
## Trying to call a tool that needs a rootPath as a parameter
33+
- Always use the standard, non-URL-encoded file system path
34+
35+
## CRITICAL: Dependencies and Security Checks
36+
- IMMEDIATELY after ANY of these actions:
37+
- Running npm/yarn/pnpm install
38+
- Adding dependencies to package.json
39+
- Adding requirements to requirements.txt
40+
- Adding dependencies to pom.xml
41+
- Adding dependencies to build.gradle
42+
- Any other package manager operations
43+
- You MUST run the `codacy_cli_analyze` tool with:
44+
- `rootPath`: set to the workspace path
45+
- `tool`: set to "trivy"
46+
- `file`: leave empty or unset
47+
- If any vulnerabilities are found because of the newly added packages:
48+
- Stop all other operations
49+
- Propose and apply fixes for the security issues
50+
- Only continue with the original task after security issues are resolved
51+
- EXAMPLE:
52+
- After: npm install react-markdown
53+
- Do: Run codacy_cli_analyze with trivy
54+
- Before: Continuing with any other tasks
55+
56+
## General
57+
- Repeat the relevant steps for each modified file.
58+
- "Propose fixes" means to both suggest and, if possible, automatically apply the fixes.
59+
- You MUST NOT wait for the user to ask for analysis or remind you to run the tool.
60+
- Do not run `codacy_cli_analyze` looking for changes in duplicated code or code complexity metrics.
61+
- Complexity metrics are different from complexity issues. When trying to fix complexity in a repository or file, focus on solving the complexity issues and ignore the complexity metric.
62+
- Do not run `codacy_cli_analyze` looking for changes in code coverage.
63+
- Do not try to manually install Codacy CLI using either brew, npm, npx, or any other package manager.
64+
- If the Codacy CLI is not installed, just run the `codacy_cli_analyze` tool from Codacy's MCP Server.
65+
- When calling `codacy_cli_analyze`, only send provider, organization and repository if the project is a git repository.
66+
67+
## Whenever a call to a Codacy tool that uses `repository` or `organization` as a parameter returns a 404 error
68+
- Offer to run the `codacy_setup_repository` tool to add the repository to Codacy
69+
- If the user accepts, run the `codacy_setup_repository` tool
70+
- Do not ever try to run the `codacy_setup_repository` tool on your own
71+
- After setup, immediately retry the action that failed (only retry once)
72+
---

‎.github/workflows/build.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: 🏗️ Build
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- name: Setup Python
14+
uses: actions/setup-python@v5
15+
with:
16+
python-version: "3.11"
17+
- name: Install dependencies
18+
run: |
19+
python -m pip install --upgrade pip
20+
pip install -r requirements.txt
21+
- name: Build package
22+
run: |
23+
mkdir -p dist
24+
zip -r dist/vectobeat.zip src config.yml requirements.txt .env
25+
- name: Upload Artifact
26+
uses: actions/upload-artifact@v4
27+
with:
28+
name: vectobeat-build
29+
path: dist/vectobeat.zip

‎.github/workflows/deploy.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 🚀 Deploy VectoBeat
2+
3+
on:
4+
release:
5+
types: [published]
6+
workflow_dispatch:
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- name: Setup Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: "3.11"
18+
19+
- name: Install dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install -r requirements.txt
23+
24+
- name: Deploy to Production
25+
env:
26+
DISCORD_TOKEN: ${{ secrets.DISCORD_TOKEN }}
27+
LAVALINK_HOST: ${{ secrets.LAVALINK_HOST }}
28+
LAVALINK_PORT: ${{ secrets.LAVALINK_PORT }}
29+
LAVALINK_PASSWORD: ${{ secrets.LAVALINK_PASSWORD }}
30+
run: |
31+
echo "🚀 Deploying VectoBeat..."
32+
python -m src.main

‎.github/workflows/test.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: 🧪 Tests
2+
3+
on:
4+
push:
5+
branches: [main, develop]
6+
pull_request:
7+
branches: [main, develop]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
python-version: ["3.10", "3.11"]
15+
steps:
16+
- uses: actions/checkout@v4
17+
- name: Setup Python
18+
uses: actions/setup-python@v5
19+
with:
20+
python-version: ${{ matrix.python-version }}
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip
24+
pip install -r requirements.txt
25+
- name: Lint
26+
run: |
27+
pip install flake8
28+
flake8 src --max-line-length=120
29+
- name: Run tests
30+
run: |
31+
pip install pytest
32+
pytest -v

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,3 +205,7 @@ cython_debug/
205205
marimo/_static/
206206
marimo/_lsp/
207207
__marimo__/
208+
209+
210+
#Ignore vscode AI rules
211+
.github\instructions\codacy.instructions.md

‎CODE_OF_CONDUCT.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<div align="center">
2+
<img src="https://raw.githubusercontent.com/VectoDE/VectoBeat/main/assets/images/logo.png" alt="VectoBeat Logo" width="180" />
3+
<h1>Code of Conduct</h1>
4+
<p>VectoBeat adopts the Contributor Covenant to foster a welcoming, professional community.</p>
5+
</div>
6+
7+
<hr />
8+
9+
<h2>📜 Our Pledge</h2>
10+
<p>We, as contributors and maintainers, pledge to create an inclusive environment where participants feel safe, respected, and valued. We are committed to a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.</p>
11+
12+
<hr />
13+
14+
<h2>🤝 Expected Behaviour</h2>
15+
<ul>
16+
<li>Demonstrate empathy and kindness toward other people.</li>
17+
<li>Communicate respectfully and constructively, especially when providing feedback.</li>
18+
<li>Accept responsibility and apologise when mistakes are made, learning from the experience.</li>
19+
<li>Focus on what is best for the community and project.</li>
20+
</ul>
21+
22+
<h2>🚫 Unacceptable Behaviour</h2>
23+
<ul>
24+
<li>Harassment, trolling, or abusive/derogatory comments.</li>
25+
<li>Public or private harassment, including doxxing or publishing private information.</li>
26+
<li>Any conduct or content that is inappropriate in a professional setting.</li>
27+
<li>Plagiarism or misrepresentation of work.</li>
28+
</ul>
29+
30+
<hr />
31+
32+
<h2>📣 Enforcement Responsibilities</h2>
33+
<p>Project maintainers are responsible for clarifying standards of acceptable behaviour and are expected to take appropriate and fair corrective action when unacceptable behaviour is reported or observed.</p>
34+
35+
<p>Maintainers have the right and responsibility to remove, edit, or reject contributions that do not align with this Code of Conduct.</p>
36+
37+
<hr />
38+
39+
<h2>🛡️ Enforcement Guidelines</h2>
40+
<ol>
41+
<li><strong>Correction:</strong> Private warning with clarity on the issue.</li>
42+
<li><strong>Warning:</strong> Public warning regarding continued behaviour.</li>
43+
<li><strong>Temporary Ban:</strong> Time-boxed exclusion from project spaces.</li>
44+
<li><strong>Permanent Ban:</strong> Removal from project spaces for severe or repeated violations.</li>
45+
</ol>
46+
47+
<hr />
48+
49+
<h2>📬 Reporting</h2>
50+
<p>Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by emailing the maintainers at <a href="mailto:timhauke@uplytech.de">timhauke@uplytech.de</a>.</p>
51+
<p>All complaints will be reviewed and investigated promptly and fairly. Confidentiality will be maintained to the extent possible.</p>
52+
53+
<hr />
54+
55+
<h2>🔁 Scope</h2>
56+
<p>This Code of Conduct applies within project spaces and in public spaces when an individual is representing the project or community.</p>
57+
58+
<hr />
59+
60+
<h2>📄 Attribution</h2>
61+
<p>This Code of Conduct is adapted from the <a href="https://www.contributor-covenant.org/version/2/1/code_of_conduct.html">Contributor Covenant v2.1</a>. Community Impact Guidelines were inspired by the Mozilla CoC.</p>
62+
63+
<p align="center" style="margin-top: 2rem;"><em>Thank you for supporting a welcoming, professional community.</em></p>

0 commit comments

Comments
 (0)