git-repokit 0.9.10__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- git_repokit-0.9.10.dist-info/METADATA +422 -0
- git_repokit-0.9.10.dist-info/RECORD +174 -0
- git_repokit-0.9.10.dist-info/WHEEL +5 -0
- git_repokit-0.9.10.dist-info/entry_points.txt +2 -0
- git_repokit-0.9.10.dist-info/licenses/LICENSE +9 -0
- git_repokit-0.9.10.dist-info/top_level.txt +1 -0
- repokit/__init__.py +8 -0
- repokit/__main__.py +12 -0
- repokit/__version__.py +4 -0
- repokit/_vendor/__init__.py +0 -0
- repokit/_vendor/ailib/__init__.py +1 -0
- repokit/_vendor/ailib/analyzer.py +177 -0
- repokit/_vendor/ailib/backend.py +95 -0
- repokit/_vendor/ailib/cache.py +97 -0
- repokit/_vendor/ailib/parsers.py +52 -0
- repokit/_vendor/ailib/transports/__init__.py +16 -0
- repokit/_vendor/ailib/transports/cli.py +312 -0
- repokit/_vendor/ailib/transports/openai_compat.py +383 -0
- repokit/_vendor/ailib/transports/prompt_file.py +41 -0
- repokit/_vendor/ailib/types.py +224 -0
- repokit/auth_integration.py +244 -0
- repokit/badges.py +183 -0
- repokit/branch_utils.py +364 -0
- repokit/cli.py +2997 -0
- repokit/common_kit.py +202 -0
- repokit/config.py +686 -0
- repokit/defaults.py +220 -0
- repokit/directory_analyzer.py +1244 -0
- repokit/directory_profiles.py +423 -0
- repokit/git_config.py +370 -0
- repokit/github_create.py +142 -0
- repokit/github_setup.py +248 -0
- repokit/guardrails.py +707 -0
- repokit/history_cleaner.py +449 -0
- repokit/history_protection.py +434 -0
- repokit/hooks/pre-commit-guardrails +122 -0
- repokit/hooks/pre-commit-template +28 -0
- repokit/layers.py +510 -0
- repokit/licenses/0bsd.txt +14 -0
- repokit/licenses/LICENSES.md +27 -0
- repokit/licenses/__init__.py +142 -0
- repokit/licenses/agpl-3.0.txt +661 -0
- repokit/licenses/all-rights-reserved.txt +10 -0
- repokit/licenses/apache-2.0.txt +201 -0
- repokit/licenses/bsd-2-clause.txt +24 -0
- repokit/licenses/bsd-3-clause.txt +28 -0
- repokit/licenses/bsl-1.0.txt +23 -0
- repokit/licenses/cc-by-4.0.txt +395 -0
- repokit/licenses/cc-by-sa-4.0.txt +427 -0
- repokit/licenses/cc0-1.0.txt +121 -0
- repokit/licenses/epl-2.0.txt +277 -0
- repokit/licenses/gpl-2.0.txt +339 -0
- repokit/licenses/gpl-3.0.txt +674 -0
- repokit/licenses/isc.txt +15 -0
- repokit/licenses/lgpl-2.1.txt +504 -0
- repokit/licenses/lgpl-3.0.txt +165 -0
- repokit/licenses/mit.txt +21 -0
- repokit/licenses/mpl-2.0.txt +373 -0
- repokit/licenses/unlicense.txt +24 -0
- repokit/readme_blocks.py +112 -0
- repokit/remote_integration.py +627 -0
- repokit/repo_manager.py +2796 -0
- repokit/template_engine.py +391 -0
- repokit/templates/ai/claude/CLAUDE-nested.md.template +25 -0
- repokit/templates/ai/claude/CLAUDE.md.template +98 -0
- repokit/templates/ai/claude/instructions/step1_context_rebuilder.md +33 -0
- repokit/templates/ai/claude/instructions/step2_dev_workflow_process.md +67 -0
- repokit/templates/ai/claude/instructions/step3_context_bridge.md +52 -0
- repokit/templates/common/CHANGELOG.md.template +15 -0
- repokit/templates/common/CONTRIBUTING.md.template +31 -0
- repokit/templates/common/README.md.template +30 -0
- repokit/templates/common/gitattributes.template +17 -0
- repokit/templates/common/gitignore.template +141 -0
- repokit/templates/extras/FUNDING.yml.template +13 -0
- repokit/templates/extras/ROADMAP.md.template +17 -0
- repokit/templates/extras/dependabot.yml.template +22 -0
- repokit/templates/extras/one-offs-README.md.template +28 -0
- repokit/templates/extras/platform-support.md.template +11 -0
- repokit/templates/extras/pull_request_template.md.template +25 -0
- repokit/templates/extras/release-template.md.template +34 -0
- repokit/templates/extras/settings.json.template +11 -0
- repokit/templates/extras/stale.yml.template +14 -0
- repokit/templates/github/CODEOWNERS.template +11 -0
- repokit/templates/github/ISSUE_TEMPLATE/bug-report.md.template +29 -0
- repokit/templates/github/ISSUE_TEMPLATE/feature-request.md.template +19 -0
- repokit/templates/github/issues/notes.md.template +18 -0
- repokit/templates/github/issues/roadmap.md.template +15 -0
- repokit/templates/hooks/pre-commit.template +64 -0
- repokit/templates/layers/archetypes/any/claude-plugin/.claude-plugin/marketplace.json +20 -0
- repokit/templates/layers/archetypes/any/claude-plugin/plugin/.claude-plugin/plugin.json +15 -0
- repokit/templates/layers/archetypes/any/claude-plugin/plugin/README.md +28 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/.github/workflows/ci-c-cpp.yml +24 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/.repokit-common.toml.rkappend +4 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/.vscode/launch.json +29 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/.vscode/tasks.json +26 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/CMakeLists.txt +47 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/CMakePresets.json +23 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/cmake/GenerateStamp.cmake +45 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/src/main.cpp +27 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/tests/test_version.cpp +20 -0
- repokit/templates/layers/archetypes/c-cpp/cmake-app/vcpkg.json +5 -0
- repokit/templates/layers/archetypes/c-cpp/minimal/.vscode/launch.json +27 -0
- repokit/templates/layers/archetypes/c-cpp/minimal/Makefile +10 -0
- repokit/templates/layers/archetypes/c-cpp/minimal/build.bat +7 -0
- repokit/templates/layers/archetypes/c-cpp/minimal/src/__RK_SNAKE__.c +26 -0
- repokit/templates/layers/archetypes/c-cpp/msbuild/.vscode/launch.json +17 -0
- repokit/templates/layers/archetypes/c-cpp/msbuild/.vscode/tasks.json +20 -0
- repokit/templates/layers/archetypes/c-cpp/msbuild/__RK_PROJECT__.sln +19 -0
- repokit/templates/layers/archetypes/c-cpp/msbuild/__RK_PROJECT__.vcxproj +41 -0
- repokit/templates/layers/archetypes/c-cpp/msbuild/src/main.cpp +26 -0
- repokit/templates/layers/archetypes/js-ts/claude-plugin/.repokit-common.toml +28 -0
- repokit/templates/layers/archetypes/js-ts/claude-plugin/.vscode/launch.json +34 -0
- repokit/templates/layers/archetypes/js-ts/claude-plugin/plugin/hooks/hooks.json +15 -0
- repokit/templates/layers/archetypes/js-ts/claude-plugin/plugin/hooks/scripts/session-start.mjs +23 -0
- repokit/templates/layers/archetypes/js-ts/claude-plugin/plugin/tests/manifest.test.js +30 -0
- repokit/templates/layers/archetypes/js-ts/node/.repokit-common.toml.rkappend +6 -0
- repokit/templates/layers/archetypes/js-ts/node/package.json +13 -0
- repokit/templates/layers/archetypes/js-ts/node-package/.github/workflows/release.yml +39 -0
- repokit/templates/layers/archetypes/js-ts/node-package/package.json +32 -0
- repokit/templates/layers/archetypes/js-ts/node-package/src/index.ts +13 -0
- repokit/templates/layers/archetypes/js-ts/node-package/tests/index.test.ts +11 -0
- repokit/templates/layers/archetypes/js-ts/script/.vscode/launch.json +34 -0
- repokit/templates/layers/archetypes/js-ts/script/__RK_PROJECT__.js +37 -0
- repokit/templates/layers/archetypes/js-ts/script/tests/version.test.js +26 -0
- repokit/templates/layers/archetypes/js-ts/ts/package.json +18 -0
- repokit/templates/layers/archetypes/js-ts/ts/tsconfig.json +15 -0
- repokit/templates/layers/archetypes/python/claude-plugin/.github/workflows/ci-python.yml +44 -0
- repokit/templates/layers/archetypes/python/claude-plugin/.repokit-common.toml +21 -0
- repokit/templates/layers/archetypes/python/claude-plugin/.vscode/launch.json +33 -0
- repokit/templates/layers/archetypes/python/claude-plugin/VERSION +1 -0
- repokit/templates/layers/archetypes/python/claude-plugin/plugin/hooks/hooks.json +15 -0
- repokit/templates/layers/archetypes/python/claude-plugin/plugin/hooks/scripts/run-hook.mjs +42 -0
- repokit/templates/layers/archetypes/python/claude-plugin/plugin/hooks/scripts/session_start.py +31 -0
- repokit/templates/layers/archetypes/python/claude-plugin/plugin/tests/test_manifest.py +42 -0
- repokit/templates/layers/archetypes/python/pypi/.github/workflows/release.yml +63 -0
- repokit/templates/layers/archetypes/python/pypi/.vscode/launch.json +43 -0
- repokit/templates/layers/archetypes/python/pypi/__RK_SNAKE__/__init__.py +5 -0
- repokit/templates/layers/archetypes/python/pypi/__RK_SNAKE__/__main__.py +6 -0
- repokit/templates/layers/archetypes/python/pypi/__RK_SNAKE__/_version.py +96 -0
- repokit/templates/layers/archetypes/python/pypi/__RK_SNAKE__/cli.py +18 -0
- repokit/templates/layers/archetypes/python/pypi/pyproject.toml +71 -0
- repokit/templates/layers/archetypes/python/pypi/tests/conftest.py +11 -0
- repokit/templates/layers/archetypes/python/pypi/tests/test_version.py +50 -0
- repokit/templates/layers/archetypes/python/script/.github/workflows/ci-python.yml +43 -0
- repokit/templates/layers/archetypes/python/script/.repokit-common.toml +14 -0
- repokit/templates/layers/archetypes/python/script/.vscode/launch.json +33 -0
- repokit/templates/layers/archetypes/python/script/VERSION +1 -0
- repokit/templates/layers/archetypes/python/script/__RK_PROJECT__.py +40 -0
- repokit/templates/layers/archetypes/python/script/tests/test_version.py +25 -0
- repokit/templates/layers/archetypes/python/setuppy/requirements.txt +8 -0
- repokit/templates/layers/archetypes/python/setuppy/setup.py +23 -0
- repokit/templates/layers/languages/c-cpp/.gitignore.rkappend +20 -0
- repokit/templates/layers/languages/c-cpp/.repokit-common.toml +7 -0
- repokit/templates/layers/languages/c-cpp/include/__RK_SNAKE__/version.h +20 -0
- repokit/templates/layers/languages/c-cpp/src/app.rc +25 -0
- repokit/templates/layers/languages/js-ts/.editorconfig +15 -0
- repokit/templates/layers/languages/js-ts/.github/workflows/ci-js-ts.yml +41 -0
- repokit/templates/layers/languages/js-ts/.gitignore.rkappend +13 -0
- repokit/templates/layers/languages/js-ts/.repokit-common.toml +19 -0
- repokit/templates/layers/languages/js-ts/.vscode/launch.json +24 -0
- repokit/templates/layers/languages/js-ts/VERSION +1 -0
- repokit/templates/layers/languages/python/.github/workflows/ci-python.yml +76 -0
- repokit/templates/layers/languages/python/.gitignore.rkappend +15 -0
- repokit/templates/layers/languages/python/.vscode/launch.json +33 -0
- repokit/templates/layers/manifest.toml +302 -0
- repokit/templates/vault/CLAUDE.md +29 -0
- repokit/templates/vault/claude/_maps/MOC-project.md +15 -0
- repokit/templates/vault/claude/_oracle/backlinks.md +3 -0
- repokit/templates/vault/claude/_oracle/concepts.md +12 -0
- repokit/templates/vault/claude/_oracle/manifest.md +10 -0
- repokit/templates/vault/claude/_todo/ACTIVE-WORK.md +18 -0
- repokit/templates/vault/claude/_todo/OPEN-LOOPS.md +14 -0
- repokit/utils.py +316 -0
- repokit/vault.py +248 -0
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Contributing to $project_name
|
|
2
|
+
|
|
3
|
+
Thank you for considering contributing to $project_name!
|
|
4
|
+
|
|
5
|
+
## Development Setup
|
|
6
|
+
|
|
7
|
+
### Prerequisites
|
|
8
|
+
|
|
9
|
+
$prerequisites
|
|
10
|
+
|
|
11
|
+
### Clone and set up
|
|
12
|
+
|
|
13
|
+
$setup_block
|
|
14
|
+
|
|
15
|
+
### Run the tests
|
|
16
|
+
|
|
17
|
+
$test_block
|
|
18
|
+
|
|
19
|
+
${version_section}## Key Design Principles
|
|
20
|
+
|
|
21
|
+
1. **Tests are important** -- write tests for new features
|
|
22
|
+
2. **One-offs graduate** -- quick checks in `tests/one-offs/` can be promoted to proper tests
|
|
23
|
+
3. **Cross-platform** -- works on Windows, Linux and macOS
|
|
24
|
+
4. **Clean commits** -- use the conventional commit format
|
|
25
|
+
|
|
26
|
+
## Pull Requests
|
|
27
|
+
|
|
28
|
+
1. Fork the repository and create a branch
|
|
29
|
+
2. Make your change, with tests
|
|
30
|
+
3. Run the tests
|
|
31
|
+
4. Open a pull request describing what changed and why
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# $project_name
|
|
2
|
+
|
|
3
|
+
$badges
|
|
4
|
+
|
|
5
|
+
$description
|
|
6
|
+
|
|
7
|
+
${install_section}${usage_section}## Development
|
|
8
|
+
|
|
9
|
+
Prerequisites:
|
|
10
|
+
|
|
11
|
+
$prerequisites
|
|
12
|
+
|
|
13
|
+
Setup:
|
|
14
|
+
|
|
15
|
+
$setup_block
|
|
16
|
+
|
|
17
|
+
Tests:
|
|
18
|
+
|
|
19
|
+
$test_block
|
|
20
|
+
|
|
21
|
+
## Contributing
|
|
22
|
+
|
|
23
|
+
Contributions welcome! Please open an issue or submit a pull request.
|
|
24
|
+
|
|
25
|
+
See **[CONTRIBUTING.md](CONTRIBUTING.md)** for:
|
|
26
|
+
$contributing_covers
|
|
27
|
+
|
|
28
|
+
${support_line}## License
|
|
29
|
+
|
|
30
|
+
$license_line
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Line endings: git normalises text files to LF in the repository and gives
|
|
2
|
+
# each platform its own on checkout. Files that must keep their bytes are
|
|
3
|
+
# listed as binary.
|
|
4
|
+
* text=auto
|
|
5
|
+
*.png binary
|
|
6
|
+
*.jpg binary
|
|
7
|
+
*.jpeg binary
|
|
8
|
+
*.gif binary
|
|
9
|
+
*.ico binary
|
|
10
|
+
*.pdf binary
|
|
11
|
+
*.zip binary
|
|
12
|
+
*.woff binary
|
|
13
|
+
*.woff2 binary
|
|
14
|
+
|
|
15
|
+
# The vendored git-repokit-common tooling is not this project's language:
|
|
16
|
+
# GitHub's language statistics and diffs treat it as vendored.
|
|
17
|
+
scripts/repokit-common/** linguist-vendored
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# Enhanced .gitignore for RepoKit Projects
|
|
2
|
+
# This template provides comprehensive exclusions for various languages and tools
|
|
3
|
+
|
|
4
|
+
#######################
|
|
5
|
+
# Common ignored files #
|
|
6
|
+
#######################
|
|
7
|
+
.DS_Store
|
|
8
|
+
Thumbs.db
|
|
9
|
+
desktop.ini
|
|
10
|
+
*.log
|
|
11
|
+
*.tmp
|
|
12
|
+
*.bak
|
|
13
|
+
*.swp
|
|
14
|
+
*~
|
|
15
|
+
*.*~
|
|
16
|
+
|
|
17
|
+
#######################
|
|
18
|
+
# Project Directories #
|
|
19
|
+
#######################
|
|
20
|
+
|
|
21
|
+
# RepoKit standard private directories
|
|
22
|
+
/private/
|
|
23
|
+
/convos/
|
|
24
|
+
/logs/
|
|
25
|
+
/credentials/
|
|
26
|
+
/secrets/
|
|
27
|
+
**/__private__*
|
|
28
|
+
|
|
29
|
+
# Local development files
|
|
30
|
+
local/
|
|
31
|
+
.local/
|
|
32
|
+
.dev/
|
|
33
|
+
|
|
34
|
+
#######################
|
|
35
|
+
# Python #
|
|
36
|
+
#######################
|
|
37
|
+
|
|
38
|
+
# Byte-compiled / optimized / DLL files
|
|
39
|
+
__pycache__/
|
|
40
|
+
*.py[cod]
|
|
41
|
+
*$py.class
|
|
42
|
+
*.so
|
|
43
|
+
.Python
|
|
44
|
+
|
|
45
|
+
# Distribution / packaging
|
|
46
|
+
dist/
|
|
47
|
+
build/
|
|
48
|
+
develop-eggs/
|
|
49
|
+
downloads/
|
|
50
|
+
eggs/
|
|
51
|
+
.eggs/
|
|
52
|
+
lib/
|
|
53
|
+
lib64/
|
|
54
|
+
parts/
|
|
55
|
+
sdist/
|
|
56
|
+
var/
|
|
57
|
+
wheels/
|
|
58
|
+
share/python-wheels/
|
|
59
|
+
*.egg-info/
|
|
60
|
+
.installed.cfg
|
|
61
|
+
*.egg
|
|
62
|
+
MANIFEST
|
|
63
|
+
|
|
64
|
+
# Virtual environments
|
|
65
|
+
venv/
|
|
66
|
+
env/
|
|
67
|
+
ENV/
|
|
68
|
+
.env/
|
|
69
|
+
.venv/
|
|
70
|
+
env.bak/
|
|
71
|
+
venv.bak/
|
|
72
|
+
pythonenv*
|
|
73
|
+
|
|
74
|
+
# Testing / coverage
|
|
75
|
+
.tox/
|
|
76
|
+
.coverage
|
|
77
|
+
.coverage.*
|
|
78
|
+
.cache/
|
|
79
|
+
nosetests.xml
|
|
80
|
+
coverage.xml
|
|
81
|
+
*.cover
|
|
82
|
+
*.py,cover
|
|
83
|
+
.hypothesis/
|
|
84
|
+
.pytest_cache/
|
|
85
|
+
cover/
|
|
86
|
+
htmlcov/
|
|
87
|
+
|
|
88
|
+
#######################
|
|
89
|
+
# IDEs and Editors #
|
|
90
|
+
#######################
|
|
91
|
+
|
|
92
|
+
# Visual Studio Code
|
|
93
|
+
.vscode/*
|
|
94
|
+
!.vscode/settings.json
|
|
95
|
+
!.vscode/tasks.json
|
|
96
|
+
!.vscode/launch.json
|
|
97
|
+
!.vscode/extensions.json
|
|
98
|
+
*.code-workspace
|
|
99
|
+
.history/
|
|
100
|
+
|
|
101
|
+
# JetBrains
|
|
102
|
+
.idea/
|
|
103
|
+
*.iml
|
|
104
|
+
*.ipr
|
|
105
|
+
*.iws
|
|
106
|
+
.idea_modules/
|
|
107
|
+
out/
|
|
108
|
+
|
|
109
|
+
# Environment files
|
|
110
|
+
.env
|
|
111
|
+
.env.local
|
|
112
|
+
.env.development.local
|
|
113
|
+
.env.test.local
|
|
114
|
+
.env.production.local
|
|
115
|
+
|
|
116
|
+
#######################
|
|
117
|
+
# Security & Secrets #
|
|
118
|
+
#######################
|
|
119
|
+
|
|
120
|
+
# Token and credential files
|
|
121
|
+
*token*
|
|
122
|
+
*credential*
|
|
123
|
+
*secret*
|
|
124
|
+
*password*
|
|
125
|
+
.env
|
|
126
|
+
.secret
|
|
127
|
+
credentials.json
|
|
128
|
+
*auth*.json
|
|
129
|
+
*config*.json
|
|
130
|
+
|
|
131
|
+
# Project-specific directories
|
|
132
|
+
/log/
|
|
133
|
+
/logs/
|
|
134
|
+
/private/
|
|
135
|
+
/convos/
|
|
136
|
+
|
|
137
|
+
#######################
|
|
138
|
+
# Project Specific #
|
|
139
|
+
#######################
|
|
140
|
+
|
|
141
|
+
# Add custom patterns below
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Roadmap
|
|
2
|
+
|
|
3
|
+
The living roadmap for $project_name lives in the repository's first issue, kept pinned: https://github.com/$github_org/$project_name/issues/1. Notes and quick ideas go to the second: https://github.com/$github_org/$project_name/issues/2.
|
|
4
|
+
|
|
5
|
+
This file points there so a reader of the tree finds the plan; the issue holds the detail and its history.
|
|
6
|
+
|
|
7
|
+
## Now
|
|
8
|
+
|
|
9
|
+
-
|
|
10
|
+
|
|
11
|
+
## Next
|
|
12
|
+
|
|
13
|
+
-
|
|
14
|
+
|
|
15
|
+
## Later
|
|
16
|
+
|
|
17
|
+
-
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
version: 2
|
|
2
|
+
updates:
|
|
3
|
+
# Python dependencies
|
|
4
|
+
- package-ecosystem: "pip"
|
|
5
|
+
directory: "/"
|
|
6
|
+
schedule:
|
|
7
|
+
interval: "weekly"
|
|
8
|
+
open-pull-requests-limit: 10
|
|
9
|
+
labels:
|
|
10
|
+
- "pip"
|
|
11
|
+
- "dependencies"
|
|
12
|
+
versioning-strategy: increase-if-necessary
|
|
13
|
+
|
|
14
|
+
# GitHub Actions
|
|
15
|
+
- package-ecosystem: "github-actions"
|
|
16
|
+
directory: "/"
|
|
17
|
+
schedule:
|
|
18
|
+
interval: "monthly"
|
|
19
|
+
labels:
|
|
20
|
+
- "github-actions"
|
|
21
|
+
- "dependencies"
|
|
22
|
+
open-pull-requests-limit: 5
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# One-Off Scripts
|
|
2
|
+
|
|
3
|
+
Quick checks, one-time diagnostics, and proof-of-concept scripts go here.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
This folder is the starting point for experimental code. Scripts here are:
|
|
8
|
+
- Quick tests of an idea before writing a proper test
|
|
9
|
+
- Diagnostic tools for debugging a specific issue
|
|
10
|
+
- Proof-of-concept implementations
|
|
11
|
+
|
|
12
|
+
## Graduation Path
|
|
13
|
+
|
|
14
|
+
Scripts naturally evolve through stages:
|
|
15
|
+
|
|
16
|
+
1. **`tests/one-offs/`** -- Start here. Quick checks, one-time diagnostics.
|
|
17
|
+
2. **`tests/`** -- When a one-off proves its value as a repeatable test (pytest-style regression).
|
|
18
|
+
3. **`scripts/`** -- When a one-off proves its value as a reusable utility/diagnostic tool.
|
|
19
|
+
4. **Project source** -- When a script becomes integral to the project's functionality.
|
|
20
|
+
|
|
21
|
+
Flow: `one-offs -> tests` (elevated to regression) XOR `one-offs -> scripts` (elevated to reusable tool), and eventually `scripts -> project source` when the tool is genuinely part of the program.
|
|
22
|
+
|
|
23
|
+
## Guidelines
|
|
24
|
+
|
|
25
|
+
- Include one-off scripts in commits (they document what you were investigating and why)
|
|
26
|
+
- Name scripts descriptively: `test_does_foo_handle_unicode.py`, not `test1.py`
|
|
27
|
+
- Add a brief comment at the top explaining what the script tests/investigates
|
|
28
|
+
- Don't worry about code quality here -- this is a scratch pad
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Platform support
|
|
2
|
+
|
|
3
|
+
What $project_name is tested on, and what it is expected to run on.
|
|
4
|
+
|
|
5
|
+
| Platform | Status | Notes |
|
|
6
|
+
|---|---|---|
|
|
7
|
+
| Windows 10/11 | tested | the development platform |
|
|
8
|
+
| Linux (Ubuntu LTS) | expected | CI runs here |
|
|
9
|
+
| macOS | expected | not routinely tested |
|
|
10
|
+
|
|
11
|
+
Status words: **tested** means the suite runs there on every push; **expected** means nothing platform-specific is known to break but nobody runs the suite there routinely; **unsupported** means a known gap, named in Notes.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
## Description
|
|
2
|
+
<!-- Summary of changes -->
|
|
3
|
+
|
|
4
|
+
## Type of change
|
|
5
|
+
- [ ] Bug fix
|
|
6
|
+
- [ ] New feature
|
|
7
|
+
- [ ] Breaking change
|
|
8
|
+
- [ ] Documentation update
|
|
9
|
+
- [ ] Code refactoring
|
|
10
|
+
- [ ] Performance improvement
|
|
11
|
+
|
|
12
|
+
## How Has This Been Tested?
|
|
13
|
+
<!-- Describe test procedures -->
|
|
14
|
+
|
|
15
|
+
## Screenshots (if applicable)
|
|
16
|
+
<!-- Add screenshots if relevant -->
|
|
17
|
+
|
|
18
|
+
## Checklist:
|
|
19
|
+
- [ ] Code follows style guidelines
|
|
20
|
+
- [ ] Self-review completed
|
|
21
|
+
- [ ] Code commented where hard to understand
|
|
22
|
+
- [ ] Documentation updated
|
|
23
|
+
- [ ] No new warnings
|
|
24
|
+
- [ ] Works cross-platform (Windows, macOS, Linux)
|
|
25
|
+
- [ ] Changelog updated (if user-facing)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Release v$NEXT_VERSION
|
|
2
|
+
|
|
3
|
+
## What's Changed
|
|
4
|
+
|
|
5
|
+
### New Features
|
|
6
|
+
-
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
-
|
|
10
|
+
|
|
11
|
+
### Documentation
|
|
12
|
+
-
|
|
13
|
+
|
|
14
|
+
### Maintenance
|
|
15
|
+
-
|
|
16
|
+
|
|
17
|
+
### Breaking Changes
|
|
18
|
+
-
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
pip install $package_name
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### From Source
|
|
27
|
+
```bash
|
|
28
|
+
git clone https://github.com/$github_org/$project_name.git
|
|
29
|
+
cd $project_name
|
|
30
|
+
pip install -e .
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Full Changelog
|
|
34
|
+
$CHANGES
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# These owners will be the default owners for everything in
|
|
2
|
+
# the repo. Unless a later match takes precedence,
|
|
3
|
+
# @$github_user will be requested for review when someone opens a pull request.
|
|
4
|
+
* @$github_user
|
|
5
|
+
|
|
6
|
+
# Documentation
|
|
7
|
+
/docs/ @$github_user
|
|
8
|
+
*.md @$github_user
|
|
9
|
+
|
|
10
|
+
# GitHub CI/CD
|
|
11
|
+
/.github/ @$github_user
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Create a report to help improve $project_name
|
|
4
|
+
title: "[BUG] "
|
|
5
|
+
labels: bug
|
|
6
|
+
assignees: ''
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
**Describe the bug**
|
|
10
|
+
A clear and concise description of what the bug is.
|
|
11
|
+
|
|
12
|
+
**To Reproduce**
|
|
13
|
+
Steps to reproduce the behavior:
|
|
14
|
+
1.
|
|
15
|
+
2.
|
|
16
|
+
3.
|
|
17
|
+
|
|
18
|
+
**Expected behavior**
|
|
19
|
+
A clear and concise description of what you expected to happen.
|
|
20
|
+
|
|
21
|
+
**Screenshots**
|
|
22
|
+
If applicable, add screenshots to help explain your problem.
|
|
23
|
+
|
|
24
|
+
**Environment:**
|
|
25
|
+
- OS:
|
|
26
|
+
- Version:
|
|
27
|
+
|
|
28
|
+
**Additional context**
|
|
29
|
+
Add any other context about the problem here.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Feature request
|
|
3
|
+
about: Suggest an idea for $project_name
|
|
4
|
+
title: "[FEATURE] "
|
|
5
|
+
labels: enhancement
|
|
6
|
+
assignees: ''
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
**Is your feature request related to a problem? Please describe.**
|
|
10
|
+
A clear and concise description of what the problem is.
|
|
11
|
+
|
|
12
|
+
**Describe the solution you'd like**
|
|
13
|
+
A clear and concise description of what you want to happen.
|
|
14
|
+
|
|
15
|
+
**Describe alternatives you've considered**
|
|
16
|
+
A clear and concise description of any alternative solutions or features you've considered.
|
|
17
|
+
|
|
18
|
+
**Additional context**
|
|
19
|
+
Add any other context or screenshots about the feature request here.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
## Quick Notes -- Bugs, Features, Ideas
|
|
2
|
+
|
|
3
|
+
Evergreen scratch space for $project_name: small bugs, feature seeds, and ideas that don't warrant their own issue yet. Items get promoted to proper issues when they mature.
|
|
4
|
+
|
|
5
|
+
### Bugs
|
|
6
|
+
- (none yet)
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
-
|
|
10
|
+
|
|
11
|
+
### Ideas / Research
|
|
12
|
+
-
|
|
13
|
+
|
|
14
|
+
### Architecture Notes
|
|
15
|
+
-
|
|
16
|
+
|
|
17
|
+
### Recently Completed
|
|
18
|
+
- (rolling log)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
## Roadmap
|
|
2
|
+
|
|
3
|
+
Evergreen tracking issue for $project_name development priorities. The repository's `ROADMAP.md` points here; this issue holds the detail and its history.
|
|
4
|
+
|
|
5
|
+
### Phase 1: Foundation
|
|
6
|
+
- [ ] The first working version
|
|
7
|
+
|
|
8
|
+
### Phase 2: Core Features
|
|
9
|
+
- [ ] ...
|
|
10
|
+
|
|
11
|
+
### Phase 3: Refactor / Modernization
|
|
12
|
+
- [ ] ...
|
|
13
|
+
|
|
14
|
+
### Phase 4: Advanced / Future
|
|
15
|
+
- [ ] ...
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
# Pre-commit hook to prevent committing private content to public branches
|
|
3
|
+
# Generated by RepoKit using BranchContext patterns
|
|
4
|
+
|
|
5
|
+
# Get current branch name
|
|
6
|
+
current_branch=$(git rev-parse --abbrev-ref HEAD 2>/dev/null || echo "unknown")
|
|
7
|
+
|
|
8
|
+
# Define private branches where private content is allowed (from BranchContext)
|
|
9
|
+
case "$current_branch" in
|
|
10
|
+
$private_branch_patterns)
|
|
11
|
+
echo "Checking for private content on branch: $current_branch"
|
|
12
|
+
exit 0
|
|
13
|
+
;;
|
|
14
|
+
$public_branch_patterns)
|
|
15
|
+
echo "🔍 RepoKit Pre-Commit Check"
|
|
16
|
+
echo " Branch: $current_branch (public)"
|
|
17
|
+
;;
|
|
18
|
+
*)
|
|
19
|
+
echo "🔍 RepoKit Pre-Commit Check"
|
|
20
|
+
echo " Branch: $current_branch (public)"
|
|
21
|
+
;;
|
|
22
|
+
esac
|
|
23
|
+
|
|
24
|
+
# Check for private content using BranchContext patterns
|
|
25
|
+
has_private_content=0
|
|
26
|
+
for file in $(git diff --cached --name-only); do
|
|
27
|
+
# Check against all private content patterns from BranchContext
|
|
28
|
+
if echo "$file" | grep -q -E "$private_content_regex"; then
|
|
29
|
+
if [ $has_private_content -eq 0 ]; then
|
|
30
|
+
echo ""
|
|
31
|
+
echo "❌ COMMIT BLOCKED - Private Content Protection"
|
|
32
|
+
echo ""
|
|
33
|
+
echo "ERROR: Attempting to commit private files to public branch '$current_branch':"
|
|
34
|
+
echo ""
|
|
35
|
+
has_private_content=1
|
|
36
|
+
fi
|
|
37
|
+
echo " - $file"
|
|
38
|
+
fi
|
|
39
|
+
done
|
|
40
|
+
|
|
41
|
+
if [ $has_private_content -eq 1 ]; then
|
|
42
|
+
echo ""
|
|
43
|
+
echo "These files should only exist in private branches."
|
|
44
|
+
echo "To fix this:"
|
|
45
|
+
echo " 1. Switch to private branch: git checkout private"
|
|
46
|
+
echo " 2. Or unstage these files: git reset HEAD <file>"
|
|
47
|
+
echo " 3. Or remove from working directory: rm <file>"
|
|
48
|
+
echo ""
|
|
49
|
+
exit 1
|
|
50
|
+
fi
|
|
51
|
+
|
|
52
|
+
# Check for large files (>10MB)
|
|
53
|
+
for file in $(git diff --cached --name-only); do
|
|
54
|
+
if [ -f "$file" ]; then
|
|
55
|
+
size=$(du -k "$file" | awk '{print $1}')
|
|
56
|
+
if [ "$size" -gt 10240 ]; then
|
|
57
|
+
echo "ERROR: File $file is too large ($size KB)"
|
|
58
|
+
echo "Consider using Git LFS or add to .gitignore"
|
|
59
|
+
exit 1
|
|
60
|
+
fi
|
|
61
|
+
fi
|
|
62
|
+
done
|
|
63
|
+
|
|
64
|
+
exit 0
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "__RK_PROJECT__",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "__RK_ORG__",
|
|
5
|
+
"url": "https://github.com/__RK_ORG__"
|
|
6
|
+
},
|
|
7
|
+
"metadata": {
|
|
8
|
+
"description": "__RK_DESCRIPTION__",
|
|
9
|
+
"version": "0.1.0"
|
|
10
|
+
},
|
|
11
|
+
"plugins": [
|
|
12
|
+
{
|
|
13
|
+
"name": "__RK_PROJECT__",
|
|
14
|
+
"description": "__RK_DESCRIPTION__",
|
|
15
|
+
"source": "./plugin",
|
|
16
|
+
"homepage": "https://github.com/__RK_ORG__/__RK_PROJECT__",
|
|
17
|
+
"tags": []
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "__RK_PROJECT__",
|
|
3
|
+
"displayName": "__RK_PROJECT__",
|
|
4
|
+
"description": "__RK_DESCRIPTION__",
|
|
5
|
+
"version": "0.1.0",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "__RK_AUTHOR__",
|
|
8
|
+
"email": "__RK_EMAIL__"
|
|
9
|
+
},
|
|
10
|
+
"homepage": "https://github.com/__RK_ORG__/__RK_PROJECT__",
|
|
11
|
+
"repository": "https://github.com/__RK_ORG__/__RK_PROJECT__",
|
|
12
|
+
"documentationUrl": "https://github.com/__RK_ORG__/__RK_PROJECT__/blob/main/plugin/README.md",
|
|
13
|
+
"license": "__RK_LICENSE__",
|
|
14
|
+
"keywords": [__RK_KEYWORDS__]
|
|
15
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# __RK_PROJECT__
|
|
2
|
+
|
|
3
|
+
__RK_DESCRIPTION__
|
|
4
|
+
|
|
5
|
+
This is the plugin's own README, the one Claude Code's marketplace shows. The repository's README at the root is for GitHub. Keep this one to what a person installing the plugin needs: what it does, how to install it, what it reads and writes, and where to report a problem.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
/plugin marketplace add __RK_ORG__/__RK_PROJECT__
|
|
11
|
+
/plugin install __RK_PROJECT__@__RK_PROJECT__
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## What it does
|
|
15
|
+
|
|
16
|
+
Describe the plugin's behaviour here: the hooks it registers (see `hooks/hooks.json`), the commands or skills it adds, and what a session looks like with it on.
|
|
17
|
+
|
|
18
|
+
## What it reads and writes
|
|
19
|
+
|
|
20
|
+
State plainly what the plugin reads from the session, what it stores and where, and what never leaves the machine. A plugin that touches conversation content should say so here.
|
|
21
|
+
|
|
22
|
+
## Support
|
|
23
|
+
|
|
24
|
+
Issues and questions: https://github.com/__RK_ORG__/__RK_PROJECT__/issues
|
|
25
|
+
|
|
26
|
+
## License
|
|
27
|
+
|
|
28
|
+
See `LICENSE` in the repository root.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
branches: [main]
|
|
5
|
+
pull_request:
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
build:
|
|
9
|
+
strategy:
|
|
10
|
+
fail-fast: false
|
|
11
|
+
matrix:
|
|
12
|
+
os: [windows-latest, ubuntu-latest, macos-latest]
|
|
13
|
+
runs-on: ${{ matrix.os }}
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v7
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0 # the build stamp counts commits
|
|
18
|
+
- uses: lukka/run-vcpkg@v11
|
|
19
|
+
- name: Configure
|
|
20
|
+
run: cmake -B build -S . -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE=${{ env.VCPKG_ROOT }}/scripts/buildsystems/vcpkg.cmake
|
|
21
|
+
- name: Build
|
|
22
|
+
run: cmake --build build --config Release
|
|
23
|
+
- name: Test
|
|
24
|
+
run: ctest --test-dir build -C Release --output-on-failure
|