From 7d44a9bd91629ee2d9a0e447cb543ec586a64750 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabor=20K=C3=B6rber?= Date: Thu, 15 Oct 2026 10:39:02 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=A8=20Normalize=20CRLF=20line=20ending?= =?UTF-8?q?s=20in=20workpad=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../goals/reshape_ai_skills_to_reliquary.md | 10 +- docs/workpad/goals/uv_detection.md | 58 ++--- docs/workpad/specs/commit-conventions.md | 198 +++++++++--------- 3 files changed, 133 insertions(+), 133 deletions(-) diff --git a/docs/workpad/goals/reshape_ai_skills_to_reliquary.md b/docs/workpad/goals/reshape_ai_skills_to_reliquary.md index 78e4966..22543e7 100644 --- a/docs/workpad/goals/reshape_ai_skills_to_reliquary.md +++ b/docs/workpad/goals/reshape_ai_skills_to_reliquary.md @@ -1,5 +1,5 @@ -The task is to use this repo to prepare to push to another. - -This folder contains one single plugin, which will become g4b_ai basicly as skills, because these are my core skills i use personally most, or at least, replace some that i did, so some are not yet fully adapted. but it is one plugin basicly. however i want to have themed plugins, so this should become a marketplace, which the reliquary is basicly. - -the job is to reshape this into a proper base marketplace, and push it afterwards to git@git.g4b.org:dirigence/reliquary.git instead. The .claude folder can stay, but the .claude-plugin e.g. becomes a claude plugin. core claude and readme have to be replaced, they wander also into the plugin, just as the skills folder. the reliquary should also make it possible to be used as claude marketplace and grabbing the tools independently. but it will not be only claude based, we might integrate other marketplace formats, or other skills, parallel. I do assume, this won't be an issue. +The task is to use this repo to prepare to push to another. + +This folder contains one single plugin, which will become g4b_ai basicly as skills, because these are my core skills i use personally most, or at least, replace some that i did, so some are not yet fully adapted. but it is one plugin basicly. however i want to have themed plugins, so this should become a marketplace, which the reliquary is basicly. + +the job is to reshape this into a proper base marketplace, and push it afterwards to git@git.g4b.org:dirigence/reliquary.git instead. The .claude folder can stay, but the .claude-plugin e.g. becomes a claude plugin. core claude and readme have to be replaced, they wander also into the plugin, just as the skills folder. the reliquary should also make it possible to be used as claude marketplace and grabbing the tools independently. but it will not be only claude based, we might integrate other marketplace formats, or other skills, parallel. I do assume, this won't be an issue. diff --git a/docs/workpad/goals/uv_detection.md b/docs/workpad/goals/uv_detection.md index 8afd859..33ab6d0 100644 --- a/docs/workpad/goals/uv_detection.md +++ b/docs/workpad/goals/uv_detection.md @@ -1,29 +1,29 @@ - - -- support `SCRIPTS_DIR` (default: `'scripts/'`, these are usually project shipped scripts), `SCRIPTS_STORE` (default: `'/tmp/'`, this is space to store temporary files and scripts) and `SCRIPTS_UV` (default: `''`, this is the executable to run uv) env vars in the skills boot sequence. Only react if that is successful. -- otherwise agent has to figure it out by running check_uv.py -- detect justfiles, makefiles, misefiles, check for uv or python recipes, specificly to run scripts. -- detect if project itself is a python project, or uv is there to be used by the agent. -- check_uv then should: - - detect uv pins (uv.toml, pyproject.toml, pip requirements) - - detect tainted .venv folders: custom files and folders inside .venv, using .venv as multi-python base dir, etc. should lead to a warning, as it shows that `uv` is not fully embraced in that project. - - detect default packages for skills in main check_uv: - - requests or httpx - - python-dotenv - - pydantic v2+ - - pytest - - pyyaml - - tomllib or tomli - - mcp - - reiterate env vars, and doing most detections it can do deterministically - -- running check_uv should confirm if the agent found the same conclusion. it is a chicken and egg problem, that can result in the fact, that the check_uv will tell the agent, that it detected a different running pattern, than the agent used. -- the agent finally has to decide, which method it keeps. once this is settled, and this can settle fast if everything is preconfigured, the agent is ready to use python, and both conclusions agree. -- the main task in this performative ritual is to ground on how to use scripts in the project. - -- this skills' existence is proof, that the user wants to use helper scripts in the project, and wants to utilize a uv installation locally in the project by the agent, and wants the agent to figure out, which one to use, and then not switch around later on, while the task is to actually focus on executing scripts and skills. -- it should also therefore get the idea of where a local scratch pad (SCRIPTS_STORE), project scripts folder (SCRIPTS_DIR), etc. might exist, and can therefore substitute this also as knowledge if it has to work with other tools, that want files or scripts written, but do not define where a certain folder is. These directories build good fallbacks for such concerns, and python therefore a solid tool to support the developer in tasks. -- for full python projects, it is very likely, that the configured uv is also capable of running actual project code, so namespaces should be respected. -- for rust projects, the uv configuration is almost certainly the local python environment for the agent. - -- best would be if we would simply run a universal shell that every skill should support and print out env variables that are maybe relevant immediately. + + +- support `SCRIPTS_DIR` (default: `'scripts/'`, these are usually project shipped scripts), `SCRIPTS_STORE` (default: `'/tmp/'`, this is space to store temporary files and scripts) and `SCRIPTS_UV` (default: `''`, this is the executable to run uv) env vars in the skills boot sequence. Only react if that is successful. +- otherwise agent has to figure it out by running check_uv.py +- detect justfiles, makefiles, misefiles, check for uv or python recipes, specificly to run scripts. +- detect if project itself is a python project, or uv is there to be used by the agent. +- check_uv then should: + - detect uv pins (uv.toml, pyproject.toml, pip requirements) + - detect tainted .venv folders: custom files and folders inside .venv, using .venv as multi-python base dir, etc. should lead to a warning, as it shows that `uv` is not fully embraced in that project. + - detect default packages for skills in main check_uv: + - requests or httpx + - python-dotenv + - pydantic v2+ + - pytest + - pyyaml + - tomllib or tomli + - mcp + - reiterate env vars, and doing most detections it can do deterministically + +- running check_uv should confirm if the agent found the same conclusion. it is a chicken and egg problem, that can result in the fact, that the check_uv will tell the agent, that it detected a different running pattern, than the agent used. +- the agent finally has to decide, which method it keeps. once this is settled, and this can settle fast if everything is preconfigured, the agent is ready to use python, and both conclusions agree. +- the main task in this performative ritual is to ground on how to use scripts in the project. + +- this skills' existence is proof, that the user wants to use helper scripts in the project, and wants to utilize a uv installation locally in the project by the agent, and wants the agent to figure out, which one to use, and then not switch around later on, while the task is to actually focus on executing scripts and skills. +- it should also therefore get the idea of where a local scratch pad (SCRIPTS_STORE), project scripts folder (SCRIPTS_DIR), etc. might exist, and can therefore substitute this also as knowledge if it has to work with other tools, that want files or scripts written, but do not define where a certain folder is. These directories build good fallbacks for such concerns, and python therefore a solid tool to support the developer in tasks. +- for full python projects, it is very likely, that the configured uv is also capable of running actual project code, so namespaces should be respected. +- for rust projects, the uv configuration is almost certainly the local python environment for the agent. + +- best would be if we would simply run a universal shell that every skill should support and print out env variables that are maybe relevant immediately. diff --git a/docs/workpad/specs/commit-conventions.md b/docs/workpad/specs/commit-conventions.md index a9eb2a7..4587acf 100644 --- a/docs/workpad/specs/commit-conventions.md +++ b/docs/workpad/specs/commit-conventions.md @@ -1,99 +1,99 @@ -# Commit Message Conventions - -Every commit message MUST be prefixed with a gitmoji that describes the nature of the change. - -Format: ` ` - -## Gitmoji Reference - -| Emoji | Description | -|-------|-------------| -| ๐ŸŽจ | Improve structure / format of the code | -| โšก๏ธ | Improve performance | -| ๐Ÿ”ฅ | Remove code or files | -| ๐Ÿ› | Fix a bug | -| ๐Ÿš‘๏ธ | Critical hotfix | -| โœจ | Introduce new features | -| ๐Ÿ“ | Add or update documentation | -| ๐Ÿš€ | Deploy stuff | -| ๐Ÿ’„ | Add or update the UI and style files | -| ๐ŸŽ‰ | Begin a project | -| โœ… | Add, update, or pass tests | -| ๐Ÿ”’๏ธ | Fix security or privacy issues | -| ๐Ÿ” | Add or update secrets | -| ๐Ÿ”– | Release / Version tags | -| ๐Ÿšจ | Fix compiler / linter warnings | -| ๐Ÿšง | Work in progress | -| ๐Ÿ’š | Fix CI Build | -| โฌ‡๏ธ | Downgrade dependencies | -| โฌ†๏ธ | Upgrade dependencies | -| ๐Ÿ“Œ | Pin dependencies to specific versions | -| ๐Ÿ‘ท | Add or update CI build system | -| ๐Ÿ“ˆ | Add or update analytics or track code | -| โ™ป๏ธ | Refactor code | -| โž• | Add a dependency | -| โž– | Remove a dependency | -| ๐Ÿ”ง | Add or update configuration files | -| ๐Ÿ”จ | Add or update development scripts | -| ๐ŸŒ | Internationalization and localization | -| โœ๏ธ | Fix typos | -| ๐Ÿ’ฉ | Write bad code that needs to be improved | -| โช๏ธ | Revert changes | -| ๐Ÿ”€ | Merge branches | -| ๐Ÿ“ฆ๏ธ | Add or update compiled files or packages | -| ๐Ÿ‘ฝ๏ธ | Update code due to external API changes | -| ๐Ÿšš | Move or rename resources (e.g.: files, paths, routes) | -| ๐Ÿ“„ | Add or update license | -| ๐Ÿ’ฅ | Introduce breaking changes | -| ๐Ÿฑ | Add or update assets | -| โ™ฟ๏ธ | Improve accessibility | -| ๐Ÿ’ก | Add or update comments in source code | -| ๐Ÿป | Write code drunkenly | -| ๐Ÿ’ฌ | Add or update text and literals | -| ๐Ÿ—ƒ๏ธ | Perform database related changes | -| ๐Ÿ”Š | Add or update logs | -| ๐Ÿ”‡ | Remove logs | -| ๐Ÿ‘ฅ | Add or update contributor(s) | -| ๐Ÿšธ | Improve user experience / usability | -| ๐Ÿ—๏ธ | Make architectural changes | -| ๐Ÿ“ฑ | Work on responsive design | -| ๐Ÿคก | Mock things | -| ๐Ÿฅš | Add or update an easter egg | -| ๐Ÿ™ˆ | Add or update a .gitignore file | -| ๐Ÿ“ธ | Add or update snapshots | -| โš—๏ธ | Perform experiments | -| ๐Ÿ”๏ธ | Improve SEO | -| ๐Ÿท๏ธ | Add or update types | -| ๐ŸŒฑ | Add or update seed files | -| ๐Ÿšฉ | Add, update, or remove feature flags | -| ๐Ÿฅ… | Catch errors | -| ๐Ÿ’ซ | Add or update animations and transitions | -| ๐Ÿ—‘๏ธ | Deprecate code that needs to be cleaned up | -| ๐Ÿ›‚ | Work on code related to authorization, roles and permissions | -| ๐Ÿฉน | Simple fix for a non-critical issue | -| ๐Ÿง | Data exploration / inspection | -| โšฐ๏ธ | Remove dead code | -| ๐Ÿงช | Add a failing test | -| ๐Ÿ‘” | Add or update business logic | -| ๐Ÿฉบ | Add or update healthcheck | -| ๐Ÿงฑ | Infrastructure related changes | -| ๐Ÿง‘โ€๐Ÿ’ป | Improve developer experience | -| ๐Ÿ’ธ | Add sponsorships or money related infrastructure | -| ๐Ÿงต | Add or update code related to multithreading or concurrency | -| ๐Ÿฆบ | Add or update code related to validation | -| โœˆ๏ธ | Improve offline support | -| ๐Ÿฆ– | Code that adds backwards compatibility | - -## Custom Rules - -| Emoji | Description | -|-------|-------------| -| ๐Ÿค– | Add or update agent files (CLAUDE.md, skills, AGENTS.md, copilot configs, etc.) | - -## Initial Commit - -New git repositories MUST use the following as their initial commit message: - -``` -๐Ÿฆ‡ BATMAN -``` +# Commit Message Conventions + +Every commit message MUST be prefixed with a gitmoji that describes the nature of the change. + +Format: ` ` + +## Gitmoji Reference + +| Emoji | Description | +|-------|-------------| +| ๐ŸŽจ | Improve structure / format of the code | +| โšก๏ธ | Improve performance | +| ๐Ÿ”ฅ | Remove code or files | +| ๐Ÿ› | Fix a bug | +| ๐Ÿš‘๏ธ | Critical hotfix | +| โœจ | Introduce new features | +| ๐Ÿ“ | Add or update documentation | +| ๐Ÿš€ | Deploy stuff | +| ๐Ÿ’„ | Add or update the UI and style files | +| ๐ŸŽ‰ | Begin a project | +| โœ… | Add, update, or pass tests | +| ๐Ÿ”’๏ธ | Fix security or privacy issues | +| ๐Ÿ” | Add or update secrets | +| ๐Ÿ”– | Release / Version tags | +| ๐Ÿšจ | Fix compiler / linter warnings | +| ๐Ÿšง | Work in progress | +| ๐Ÿ’š | Fix CI Build | +| โฌ‡๏ธ | Downgrade dependencies | +| โฌ†๏ธ | Upgrade dependencies | +| ๐Ÿ“Œ | Pin dependencies to specific versions | +| ๐Ÿ‘ท | Add or update CI build system | +| ๐Ÿ“ˆ | Add or update analytics or track code | +| โ™ป๏ธ | Refactor code | +| โž• | Add a dependency | +| โž– | Remove a dependency | +| ๐Ÿ”ง | Add or update configuration files | +| ๐Ÿ”จ | Add or update development scripts | +| ๐ŸŒ | Internationalization and localization | +| โœ๏ธ | Fix typos | +| ๐Ÿ’ฉ | Write bad code that needs to be improved | +| โช๏ธ | Revert changes | +| ๐Ÿ”€ | Merge branches | +| ๐Ÿ“ฆ๏ธ | Add or update compiled files or packages | +| ๐Ÿ‘ฝ๏ธ | Update code due to external API changes | +| ๐Ÿšš | Move or rename resources (e.g.: files, paths, routes) | +| ๐Ÿ“„ | Add or update license | +| ๐Ÿ’ฅ | Introduce breaking changes | +| ๐Ÿฑ | Add or update assets | +| โ™ฟ๏ธ | Improve accessibility | +| ๐Ÿ’ก | Add or update comments in source code | +| ๐Ÿป | Write code drunkenly | +| ๐Ÿ’ฌ | Add or update text and literals | +| ๐Ÿ—ƒ๏ธ | Perform database related changes | +| ๐Ÿ”Š | Add or update logs | +| ๐Ÿ”‡ | Remove logs | +| ๐Ÿ‘ฅ | Add or update contributor(s) | +| ๐Ÿšธ | Improve user experience / usability | +| ๐Ÿ—๏ธ | Make architectural changes | +| ๐Ÿ“ฑ | Work on responsive design | +| ๐Ÿคก | Mock things | +| ๐Ÿฅš | Add or update an easter egg | +| ๐Ÿ™ˆ | Add or update a .gitignore file | +| ๐Ÿ“ธ | Add or update snapshots | +| โš—๏ธ | Perform experiments | +| ๐Ÿ”๏ธ | Improve SEO | +| ๐Ÿท๏ธ | Add or update types | +| ๐ŸŒฑ | Add or update seed files | +| ๐Ÿšฉ | Add, update, or remove feature flags | +| ๐Ÿฅ… | Catch errors | +| ๐Ÿ’ซ | Add or update animations and transitions | +| ๐Ÿ—‘๏ธ | Deprecate code that needs to be cleaned up | +| ๐Ÿ›‚ | Work on code related to authorization, roles and permissions | +| ๐Ÿฉน | Simple fix for a non-critical issue | +| ๐Ÿง | Data exploration / inspection | +| โšฐ๏ธ | Remove dead code | +| ๐Ÿงช | Add a failing test | +| ๐Ÿ‘” | Add or update business logic | +| ๐Ÿฉบ | Add or update healthcheck | +| ๐Ÿงฑ | Infrastructure related changes | +| ๐Ÿง‘โ€๐Ÿ’ป | Improve developer experience | +| ๐Ÿ’ธ | Add sponsorships or money related infrastructure | +| ๐Ÿงต | Add or update code related to multithreading or concurrency | +| ๐Ÿฆบ | Add or update code related to validation | +| โœˆ๏ธ | Improve offline support | +| ๐Ÿฆ– | Code that adds backwards compatibility | + +## Custom Rules + +| Emoji | Description | +|-------|-------------| +| ๐Ÿค– | Add or update agent files (CLAUDE.md, skills, AGENTS.md, copilot configs, etc.) | + +## Initial Commit + +New git repositories MUST use the following as their initial commit message: + +``` +๐Ÿฆ‡ BATMAN +```