bigbang-skills 1.0.0
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.
- package/LICENSE +21 -0
- package/README.md +63 -0
- package/SKILL.md +136 -0
- package/install.ps1 +13 -0
- package/install.sh +16 -0
- package/package.json +32 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 luckyman147
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# BigBang — Pre-Project Rules Initializer
|
|
2
|
+
|
|
3
|
+
Agent-agnostic skill that generates `AGENTS.md` with 23 maintainability rules before starting any project. Works with **opencode**, **Gemini**, **Cline**, **Cursor**, **Copilot**, and any AI agent that reads `AGENTS.md`.
|
|
4
|
+
|
|
5
|
+
## Rules Included
|
|
6
|
+
|
|
7
|
+
| # | Rule | Description |
|
|
8
|
+
|---|------|-------------|
|
|
9
|
+
| 1 | SOLID Principles | Verifiable against SOLID before writing |
|
|
10
|
+
| 2 | YAGNI | No code until needed |
|
|
11
|
+
| 3 | Design Patterns | Use established patterns where they solve real problems |
|
|
12
|
+
| 4 | File Size Limit | Max 150 lines per file |
|
|
13
|
+
| 5 | Folder Structure | Max 3 files per directory |
|
|
14
|
+
| 6 | Naming Conventions | kebab-case, PascalCase, camelCase, UPPER_SNAKE_CASE |
|
|
15
|
+
| 7 | Documentation | Doc comments on all public APIs |
|
|
16
|
+
| 8 | Shareability | No secrets, no absolute paths, no team-specific config |
|
|
17
|
+
| 9 | Single Responsibility | One thing per function/file/module |
|
|
18
|
+
| 10 | Conventional Commits | feat:, fix:, chore:, etc. |
|
|
19
|
+
| 11 | Testing Standards | 80% coverage, unit + integration |
|
|
20
|
+
| 12 | Security Rules | No secrets, input validation, audit deps |
|
|
21
|
+
| 13 | Error Handling | Typed errors, no empty catches, structured responses |
|
|
22
|
+
| 14 | Performance Rules | No N+1, lazy loading, bundle budgets |
|
|
23
|
+
| 15 | Dependency Rules | Minimize deps, pin versions, prefer stdlib |
|
|
24
|
+
| 16 | Git Workflow | Branch naming, PR size, squash merge |
|
|
25
|
+
| 17 | Changelog & Versioning | SemVer + Keep a Changelog |
|
|
26
|
+
| 18 | API Design | RESTful, versioned, documented |
|
|
27
|
+
| 19 | Database Rules | Migrations, naming, parameterized queries |
|
|
28
|
+
| 20 | Logging & Observability | Structured JSON logs, health checks |
|
|
29
|
+
| 21 | Docker Rules | Multi-stage builds, pinned versions, non-root |
|
|
30
|
+
| 22 | Type Safety | Strict mode, no any, explicit return types |
|
|
31
|
+
| 23 | Code Review Checklist | Checks, reviews, tests, docs, size |
|
|
32
|
+
|
|
33
|
+
Also generates: linter config, CHANGELOG.md, Dockerfile, CI workflow, .env.example, and more.
|
|
34
|
+
|
|
35
|
+
## Installation
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# via npm (recommended)
|
|
39
|
+
npx bigbang-skills
|
|
40
|
+
|
|
41
|
+
# or manually — clone the repo and symlink/copy to your skills directory
|
|
42
|
+
git clone https://github.com/luckyman147/BigBang.git
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### For opencode
|
|
46
|
+
Copy the `bigbang` folder to `~/.claude/skills/` or `$env:USERPROFILE\.claude\skills\`.
|
|
47
|
+
|
|
48
|
+
### For other agents
|
|
49
|
+
Run the skill or manually generate `AGENTS.md` with the rules above — it's agent-agnostic.
|
|
50
|
+
|
|
51
|
+
## Usage
|
|
52
|
+
|
|
53
|
+
When you start a new project, simply say:
|
|
54
|
+
- "create a project"
|
|
55
|
+
- "start a new project"
|
|
56
|
+
- "setup rules"
|
|
57
|
+
- "initialize rules"
|
|
58
|
+
|
|
59
|
+
The agent will ask about your project, then generate `AGENTS.md` + config files.
|
|
60
|
+
|
|
61
|
+
## Author
|
|
62
|
+
|
|
63
|
+
**luckyman147** — [GitHub](https://github.com/luckyman147)
|
package/SKILL.md
ADDED
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bigbang
|
|
3
|
+
description: Initializes a AGENTS.md with universal code maintainability rules before creating a project. Agent-agnostic — works with opencode, Gemini, Cline, Cursor, Copilot, and any AI coding tool that reads AGENTS.md. Use when user says "create project", "start project", "new project", "setup rules", or any project initialization request.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Big Bang — Pre-Project Rules Initializer (Agent-Agnostic)
|
|
7
|
+
|
|
8
|
+
Before writing any code for a new project, create an `AGENTS.md` file in the project root with all rules below. These rules ensure the codebase remains maintainable, scalable, and shareable across teams — regardless of which AI agent (opencode, Gemini, Cline, Cursor, Copilot, etc.) works on it.
|
|
9
|
+
|
|
10
|
+
The `AGENTS.md` file is the universal standard supported by most AI coding agents. If an agent uses a different filename (e.g., `.cursorrules`, `.clinerules`), also generate that equivalent file.
|
|
11
|
+
|
|
12
|
+
## Instructions
|
|
13
|
+
|
|
14
|
+
### Step 1: Detect the trigger
|
|
15
|
+
Trigger on any of:
|
|
16
|
+
- "create a project", "start a project", "new project", "init project"
|
|
17
|
+
- "setup rules", "initialize rules", "set standards"
|
|
18
|
+
- Any request that involves starting something new from scratch
|
|
19
|
+
|
|
20
|
+
### Step 2: Ask project context (if not already provided)
|
|
21
|
+
Ask the user:
|
|
22
|
+
- What does the project do? (brief description)
|
|
23
|
+
- What language / framework?
|
|
24
|
+
- Which AI agents will work on this project? (determines which rule files to generate)
|
|
25
|
+
|
|
26
|
+
### Step 3: Generate AGENTS.md (and agent-specific files if needed)
|
|
27
|
+
Create an `AGENTS.md` file in the root of the new project. This is the universal file that opencode, Gemini, Cline, and others read.
|
|
28
|
+
|
|
29
|
+
If the user specifies additional agents, also create their config files:
|
|
30
|
+
- Cursor → also create `.cursorrules`
|
|
31
|
+
- Cline → also create `.clinerules`
|
|
32
|
+
- Copilot → also create `.github/copilot-instructions.md`
|
|
33
|
+
- Windsurf → also create `.windsurfrules`
|
|
34
|
+
|
|
35
|
+
All files contain the same rules (adapted to each format if needed). Write in plain markdown — no XML/angle brackets.
|
|
36
|
+
|
|
37
|
+
#### Required sections:
|
|
38
|
+
|
|
39
|
+
1. **SOLID Principles** — Each new class/function must be verifiable against SOLID before being written.
|
|
40
|
+
2. **YAGNI** — Do not add code, abstractions, or dependencies until they are actually needed.
|
|
41
|
+
3. **Design Patterns** — Use established design patterns (Factory, Strategy, Observer, etc.) where they solve a real problem, never for their own sake.
|
|
42
|
+
4. **File Size Limit** — Every file must stay under 150 lines. If a file exceeds 120 lines during development, refactor before continuing.
|
|
43
|
+
5. **Folder Structure** — Maximum 3 files per directory. If a directory would have a 4th file, create a subdirectory with a cohesive name.
|
|
44
|
+
6. **Naming Conventions** — Enforce consistent naming across the project:
|
|
45
|
+
- Files: `kebab-case` for config/docs, `PascalCase` for components/classes, `camelCase` for utilities
|
|
46
|
+
- Folders: `kebab-case`
|
|
47
|
+
- Variables/Functions: `camelCase`
|
|
48
|
+
- Classes/Components: `PascalCase`
|
|
49
|
+
- Constants: `UPPER_SNAKE_CASE`
|
|
50
|
+
- Booleans: prefix with `is`, `has`, `should`, `can`
|
|
51
|
+
7. **Documentation** — Every public function, class, and module must have a doc comment explaining what it does, its parameters, and its return value.
|
|
52
|
+
8. **Shareability** — No hardcoded secrets, no absolute paths, no team-specific config. All configuration must be environment-based or in `.env.example`.
|
|
53
|
+
9. **Single Responsibility** — A function does one thing. A file has one primary export. A module covers one domain.
|
|
54
|
+
10. **Conventional Commits** — All commits must follow the Conventional Commits format:
|
|
55
|
+
- `feat:` new feature
|
|
56
|
+
- `fix:` bug fix
|
|
57
|
+
- `chore:` maintenance
|
|
58
|
+
- `refactor:` code change with no behavior change
|
|
59
|
+
- `docs:` documentation only
|
|
60
|
+
- `test:` adding/fixing tests
|
|
61
|
+
- `style:` formatting, linting
|
|
62
|
+
- `perf:` performance improvement
|
|
63
|
+
- Use scope when relevant: `feat(api):`, `fix(auth):`
|
|
64
|
+
11. **Testing Standards** — Every feature must have tests:
|
|
65
|
+
- Unit tests for all pure functions and utilities
|
|
66
|
+
- Integration tests for API endpoints and data flows
|
|
67
|
+
- Test files mirror source structure under `tests/`
|
|
68
|
+
- Coverage threshold: minimum 80%
|
|
69
|
+
- Test naming: `describe('feature')` / `it('should ...')` pattern
|
|
70
|
+
- No test without an assertion
|
|
71
|
+
12. **Security Rules** — No secrets in code. No hardcoded tokens, passwords, or API keys — always use environment variables. Validate all user input. Sanitize all output. Run `npm audit` (or equivalent) before shipping. No `eval()` or dynamic code execution.
|
|
72
|
+
13. **Error Handling** — Every fallible operation must handle errors explicitly:
|
|
73
|
+
- No empty `catch` blocks
|
|
74
|
+
- Use typed errors / custom error classes
|
|
75
|
+
- Log errors with context (never log secrets)
|
|
76
|
+
- Return structured error responses in APIs
|
|
77
|
+
- Fail fast for programmer errors; handle gracefully for runtime errors
|
|
78
|
+
14. **Performance Rules** — Avoid N+1 queries (use batching/eager loading). No expensive computations in hot paths. Lazy-load heavy modules. Set bundle size budgets for frontend projects. Profile before optimizing.
|
|
79
|
+
15. **Dependency Rules** — Minimize external dependencies (every dep is a risk). Pin major versions. Audit dependencies regularly (`npm audit`, `go mod verify`, etc.). Prefer built-in / standard library solutions over npm packages. Remove unused deps.
|
|
80
|
+
16. **Git Workflow Rules** — Branch naming: `feat/description`, `fix/description`, `chore/description`. Keep PRs under 300 lines. Squash merge to main. No direct pushes to main branch. Keep commits atomic (one concern per commit). Rebase instead of merge for feature branches.
|
|
81
|
+
17. **Changelog & Versioning** — Maintain a `CHANGELOG.md` following Keep a Changelog format. Use Strict SemVer (MAJOR.MINOR.PATCH). Every release must bump the version and update the changelog. Breaking changes = MAJOR bump. New features = MINOR bump. Bug fixes = PATCH bump.
|
|
82
|
+
18. **API Design Rules** — RESTful URL conventions (plural nouns, `/api/v1/` prefix). Consistent error response shape `{ error: string, code: number }`. Pagination with `?page&limit` or cursor-based. Version your APIs (URL or header). Document all endpoints (OpenAPI/Swagger). No breaking changes without a deprecation cycle.
|
|
83
|
+
19. **Database Rules** — Use migrations for all schema changes (never raw SQL in code). Table names: `snake_case`, plural. Column names: `snake_case`. Always have `id` (PK), `created_at`, `updated_at` on every table. Index foreign keys and frequent query columns. Never use `SELECT *`. Use parameterized queries only (no raw string interpolation).
|
|
84
|
+
20. **Logging & Observability** — Use structured logging (JSON format). Define log levels: DEBUG, INFO, WARN, ERROR, FATAL. Always include `request_id` and `correlation_id` in request-scoped logs. No `console.log` in production. Add health check endpoints (`/health`, `/ready`). Expose Prometheus metrics for key operations.
|
|
85
|
+
21. **Docker Rules** — Use multi-stage builds to minimize image size. Pin base image versions (no `:latest`). Add `.dockerignore` (exclude `node_modules`, `.git`, etc.). Keep one process per container. Use non-root user. Scan images for vulnerabilities before shipping.
|
|
86
|
+
22. **Type Safety Rules** — Enable strict mode in TypeScript (or equivalent). No `any` types. No type assertions (`as`) unless unavoidable. Prefer `unknown` over `any`. All function signatures must have explicit return types. Use branded types for IDs and primitives.
|
|
87
|
+
23. **Code Review Checklist** — Every PR must: (a) pass all checks, (b) have at least one reviewer, (c) include tests for new code, (d) update docs if API changed, (e) be rebased on latest main, (f) have no unresolved comments, (g) be under 300 lines total.
|
|
88
|
+
|
|
89
|
+
### Step 4: Generate linter / formatter config
|
|
90
|
+
Based on the language/framework the user specified, generate the appropriate config file:
|
|
91
|
+
|
|
92
|
+
| Language/Framework | Config file | Tool |
|
|
93
|
+
|---|---|---|
|
|
94
|
+
| JavaScript/TypeScript | `eslint.config.js` + `.prettierrc` | ESLint + Prettier |
|
|
95
|
+
| Python | `pyproject.toml` (with `[tool.ruff]` section) | Ruff |
|
|
96
|
+
| Go | `.golangci.yml` | golangci-lint |
|
|
97
|
+
| Rust | `rustfmt.toml` + `clippy.toml` | rustfmt + Clippy |
|
|
98
|
+
| Java | `checkstyle.xml` + `.editorconfig` | Checkstyle |
|
|
99
|
+
| C# | `.editorconfig` + `stylecop.json` | StyleCop + EditorConfig |
|
|
100
|
+
| Any/fallback | `.editorconfig` | EditorConfig (universal) |
|
|
101
|
+
|
|
102
|
+
Place the config in the project root. Also add a `lint` section to AGENTS.md referencing the tool and its rules.
|
|
103
|
+
|
|
104
|
+
### Step 5: Generate supplementary config files
|
|
105
|
+
Based on the project type, generate these files where relevant:
|
|
106
|
+
|
|
107
|
+
| File | When to create |
|
|
108
|
+
|---|---|
|
|
109
|
+
| `CHANGELOG.md` | Always — with Unreleased section |
|
|
110
|
+
| `.dockerignore` | If Docker is used or user plans to containerize |
|
|
111
|
+
| `Dockerfile` | If the project is a web service or backend |
|
|
112
|
+
| `.github/workflows/ci.yml` | If the project is hosted on GitHub |
|
|
113
|
+
| `openapi.yaml` or `swagger.yaml` | If the project exposes an API |
|
|
114
|
+
| `.env.example` | Always — with placeholder values |
|
|
115
|
+
| `docker-compose.yml` | If the project needs local services (DB, cache, etc.) |
|
|
116
|
+
|
|
117
|
+
Place each file in the project root (or `.github/workflows/` for CI). Generate minimal, correct defaults — the user can expand later.
|
|
118
|
+
|
|
119
|
+
### Step 6: Create folder skeleton (optional)
|
|
120
|
+
If the user agrees, create the initial folder structure following the max-3-files-per-folder rule:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
project-root/
|
|
124
|
+
src/
|
|
125
|
+
core/
|
|
126
|
+
features/
|
|
127
|
+
shared/
|
|
128
|
+
tests/
|
|
129
|
+
config/
|
|
130
|
+
docs/
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Each folder starts empty. New subdirectories are created as the 4th file would be needed.
|
|
134
|
+
|
|
135
|
+
### Step 7: Confirm and proceed
|
|
136
|
+
Show the user a summary of everything created (AGENTS.md, agent-specific files, linter config, supplementary files) and ask if they want to adjust anything before proceeding with the project.
|
package/install.ps1
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
$skillDir = Join-Path $env:USERPROFILE ".claude\skills\bigbang"
|
|
2
|
+
$repoDir = Split-Path -Parent $MyInvocation.MyCommand.Path
|
|
3
|
+
|
|
4
|
+
if (Test-Path $skillDir) {
|
|
5
|
+
Write-Warning "bigbang skill already exists at $skillDir"
|
|
6
|
+
$choice = Read-Host "Overwrite? (y/N)"
|
|
7
|
+
if ($choice -ne "y") { exit }
|
|
8
|
+
Remove-Item -Recurse -Force $skillDir
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
New-Item -ItemType Directory -Path $skillDir -Force | Out-Null
|
|
12
|
+
Copy-Item -Recurse -Path "$repoDir\*" -Destination $skillDir -Exclude @(".git", "node_modules", "install.ps1", "install.sh")
|
|
13
|
+
Write-Host "Installed bigbang skill to $skillDir"
|
package/install.sh
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
set -euo pipefail
|
|
3
|
+
|
|
4
|
+
SKILL_DIR="${HOME}/.claude/skills/bigbang"
|
|
5
|
+
REPO_DIR="$(cd "$(dirname "$0")" && pwd)"
|
|
6
|
+
|
|
7
|
+
if [ -d "$SKILL_DIR" ]; then
|
|
8
|
+
echo "bigbang skill already exists at ${SKILL_DIR}"
|
|
9
|
+
read -rp "Overwrite? (y/N) " choice
|
|
10
|
+
if [ "$choice" != "y" ]; then exit 0; fi
|
|
11
|
+
rm -rf "$SKILL_DIR"
|
|
12
|
+
fi
|
|
13
|
+
|
|
14
|
+
mkdir -p "$SKILL_DIR"
|
|
15
|
+
cp -r "${REPO_DIR}"/SKILL.md "${SKILL_DIR}/"
|
|
16
|
+
echo "Installed bigbang skill to ${SKILL_DIR}"
|
package/package.json
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "bigbang-skills",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Pre-project rules initializer for AI coding agents (opencode, Gemini, Cline, Cursor, Copilot). Generates AGENTS.md with SOLID, YAGNI, design patterns, naming conventions, testing, security, and 20+ maintainability rules.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"opencode",
|
|
7
|
+
"claude",
|
|
8
|
+
"ai-agent",
|
|
9
|
+
"coding-rules",
|
|
10
|
+
"agents-md",
|
|
11
|
+
"bigbang",
|
|
12
|
+
"project-initializer",
|
|
13
|
+
"solid",
|
|
14
|
+
"yagni",
|
|
15
|
+
"clean-code"
|
|
16
|
+
],
|
|
17
|
+
"author": "luckyman147",
|
|
18
|
+
"license": "MIT",
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "git+https://github.com/luckyman147/BigBang.git"
|
|
22
|
+
},
|
|
23
|
+
"bugs": {
|
|
24
|
+
"url": "https://github.com/luckyman147/BigBang/issues"
|
|
25
|
+
},
|
|
26
|
+
"homepage": "https://github.com/luckyman147/BigBang#readme",
|
|
27
|
+
"files": [
|
|
28
|
+
"SKILL.md",
|
|
29
|
+
"install.ps1",
|
|
30
|
+
"install.sh"
|
|
31
|
+
]
|
|
32
|
+
}
|