Skip to content

Commit 98f4cfe

Browse files
TMHSDigitalTMHSDigital
committed
fix: correct license to CC-BY-NC-ND-4.0 and complete ecosystem standard files
The initial v0.1.0 release shipped with an MIT LICENSE, which conflicts with the ecosystem-wide CC-BY-NC-ND-4.0 convention applied by every other tool repo (Plaid, Home-Lab, CFX). Replace LICENSE with the canonical CC-BY-NC-ND-4.0 text, copyright "TM Hospitality Strategies" matching the rest of the ecosystem. Also add the three standard ecosystem files that were not in the v0.1.0 population prompt: - CONTRIBUTING.md: setup, structure, how to add skills/rules/snippets/ templates, standards-version markers, aggregate counts contract, conventional commits. - SECURITY.md: vulnerability disclosure via private security advisory, supported versions, response timeline, scope tailored to a content repo (insecure snippets, over-broad manifest permissions, unsanitized headless subprocess calls). - CODE_OF_CONDUCT.md: Contributor Covenant 2.1, with the security advisory URL adjusted for this repo. Made-with: Cursor
1 parent 98e9a57 commit 98f4cfe

4 files changed

Lines changed: 312 additions & 21 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported to the project maintainers via a
60+
[private security advisory](https://github.com/TMHSDigital/Blender-Developer-Tools/security/advisories/new)
61+
on GitHub. Do not use public issues for Code of Conduct reports.
62+
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

‎CONTRIBUTING.md‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Contributing to Blender Developer Tools
2+
3+
Thanks for helping improve this repository. This document describes how to set up locally, extend skills, rules, snippets, and the template, and submit changes.
4+
5+
## Getting Started
6+
7+
1. **Fork** the repository on GitHub.
8+
2. **Clone** your fork:
9+
10+
```bash
11+
git clone https://github.com/<your-username>/Blender-Developer-Tools.git
12+
cd Blender-Developer-Tools
13+
```
14+
15+
3. **Create a branch** for your work:
16+
17+
```bash
18+
git checkout -b your-feature-name
19+
```
20+
21+
## Repository Structure
22+
23+
This repo is a content collection (skills, rules, snippets, and one template) for Blender Python development. There is no runtime, no MCP server, and no test runner; CI validates frontmatter, syntax, and aggregate counts.
24+
25+
```text
26+
skills/
27+
<skill-name-kebab>/
28+
SKILL.md
29+
rules/
30+
<rule-name>.mdc
31+
snippets/
32+
<snippet-name>.py
33+
templates/
34+
<template-name>/
35+
blender_manifest.toml
36+
__init__.py
37+
README.md
38+
```
39+
40+
- **`skills/`** - one directory per skill, each containing `SKILL.md` with YAML frontmatter (`name`, `description`, `standards-version`).
41+
- **`rules/`** - Cursor-style rules as `.mdc` files with YAML frontmatter (`description`, `alwaysApply`, `globs`, `standards-version`).
42+
- **`snippets/`** - small standalone `.py` files (5 to 30 lines) demonstrating a single canonical pattern.
43+
- **`templates/`** - copy-paste starting points; one directory per template.
44+
45+
## Adding a Skill
46+
47+
1. Add a **kebab-case** directory under `skills/`, e.g. `skills/procedural-materials/`.
48+
2. Create **`SKILL.md`** with YAML frontmatter:
49+
50+
```yaml
51+
---
52+
name: procedural-materials
53+
description: One-line description, under 200 chars.
54+
standards-version: <current meta-repo VERSION>
55+
---
56+
```
57+
58+
3. Aim for 150 to 350 lines covering the canonical pattern, common AI mistakes, version-correctness notes, and one or two worked code examples. Cite Blender API doc URLs where relevant. Avoid encyclopedic API tours.
59+
4. The skill `name` in frontmatter must match the directory name exactly (CI enforces this).
60+
61+
## Adding a Rule
62+
63+
1. Add a **`.mdc`** file under `rules/`, e.g. `rules/avoid-python-loops-on-vertices.mdc`.
64+
2. Start with YAML **frontmatter**:
65+
66+
```yaml
67+
---
68+
description: One-line summary for humans and tooling.
69+
alwaysApply: true
70+
globs:
71+
- "**/*.py"
72+
standards-version: <current meta-repo VERSION>
73+
---
74+
```
75+
76+
3. Write 30 to 80 lines: the anti-pattern, a code example showing it wrong, a code example showing it right, and a short "Why it matters" section.
77+
78+
## Adding a Snippet
79+
80+
1. Add a `.py` file under `snippets/`, e.g. `snippets/depsgraph-evaluated-mesh.py`.
81+
2. Keep it 5 to 30 lines, fully working code, with a header comment naming the snippet and citing the relevant Blender doc URL or research section.
82+
3. Snippets are validated for Python syntax in CI.
83+
84+
## Adding a Template
85+
86+
1. Add a directory under `templates/`, e.g. `templates/headless-batch-script-template/`.
87+
2. Include all files needed for an immediate copy-paste starting point. For add-on templates, include `blender_manifest.toml`, `__init__.py`, and a brief `README.md`.
88+
89+
## Blender Version Targeting
90+
91+
Content targets **Blender 5.1** as primary, with **Blender 4.5 LTS** as fallback. When the API differs, branch on `bpy.app.version` and document both paths. Example:
92+
93+
```python
94+
if bpy.app.version >= (5, 0, 0):
95+
# 5.x path
96+
...
97+
else:
98+
# 4.5 LTS path
99+
...
100+
```
101+
102+
## Standards-version Markers
103+
104+
Files that participate in ecosystem drift checking must carry a `standards-version` marker matching the current meta-repo `VERSION`:
105+
106+
- `AGENTS.md`, `CLAUDE.md`, `ROADMAP.md`: HTML comment first line, e.g. `<!-- standards-version: 1.9.1 -->`.
107+
- `skills/*/SKILL.md`, `rules/*.mdc`: YAML frontmatter field `standards-version: 1.9.1`.
108+
109+
The drift-check workflow enforces these on every push and PR.
110+
111+
## Aggregate Counts
112+
113+
`README.md` declares aggregate counts (e.g. "8 skills, 4 rules, 1 template, and 10 snippets"). The `validate-counts` job in `.github/workflows/validate.yml` enforces these substrings against the filesystem on every push and PR. When you add or remove content, update the README counts in the same commit.
114+
115+
## Pull Request Process
116+
117+
1. **Update docs** if you change skill or rule lists, content counts, or versioning (`README.md`, `CLAUDE.md`, `ROADMAP.md` as appropriate). The release workflow rewrites `CHANGELOG.md`, `CLAUDE.md` `**Version:**` line, and `ROADMAP.md` `**Current:**` line automatically when a `feat:` or `fix:` commit lands on `main`, so only edit those files for content beyond the version markers.
118+
2. **Open a PR** against `main` with a clear title and summary of changes.
119+
3. **Use Conventional Commits** for the PR title (and ideally the merge commit). Prefixes: `feat:` (minor bump), `fix:` (patch bump), `feat!:` or `BREAKING CHANGE` (major bump), `chore:` / `docs:` / `refactor:` (no release).
120+
4. **Respond to review** feedback; CI must pass before merge.
121+
122+
## Code of Conduct
123+
124+
This project follows the guidelines in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). By participating, you agree to uphold them.

‎LICENSE‎

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
MIT License
2-
3-
Copyright (c) 2026 TMHSDigital
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.
1+
Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International
2+
3+
Copyright (c) 2026 TM Hospitality Strategies
4+
5+
This work is licensed under the Creative Commons
6+
Attribution-NonCommercial-NoDerivatives 4.0 International License.
7+
8+
You are free to:
9+
10+
Share - copy and redistribute the material in any medium or format.
11+
12+
The licensor cannot revoke these freedoms as long as you follow the
13+
license terms.
14+
15+
Under the following terms:
16+
17+
Attribution - You must give appropriate credit, provide a link to the
18+
license, and indicate if changes were made. You may do so in any
19+
reasonable manner, but not in any way that suggests the licensor
20+
endorses you or your use.
21+
22+
NonCommercial - You may not use the material for commercial purposes.
23+
24+
NoDerivatives - If you remix, transform, or build upon the material,
25+
you may not distribute the modified material.
26+
27+
No additional restrictions - You may not apply legal terms or
28+
technological measures that legally restrict others from doing
29+
anything the license permits.
30+
31+
Full license text:
32+
https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode
33+
34+
SPDX-License-Identifier: CC-BY-NC-ND-4.0

‎SECURITY.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security issue in this repository (e.g., a snippet that demonstrates an unsafe pattern, a template that ships an over-broad permission set, or a skill that recommends an insecure practice), please report it responsibly.
6+
7+
**Report:** Open a [private security advisory](https://github.com/TMHSDigital/Blender-Developer-Tools/security/advisories/new) on GitHub.
8+
9+
Please include:
10+
11+
- Description of the vulnerability
12+
- Steps to reproduce
13+
- Which skill, rule, snippet, or template is affected
14+
- Any suggested fix
15+
16+
## Scope
17+
18+
This repository ships Markdown skill files, MDC rule files, Python snippets, and one Blender extension add-on template. The primary security concerns are:
19+
20+
- **Snippets or templates demonstrating insecure patterns** (executing arbitrary code from `.blend` files, loading remote scripts without validation, leaking filesystem paths into logs).
21+
- **The extension-addon template declaring over-broad permissions** in `blender_manifest.toml` (e.g. `network`, `files`, `clipboard`, `camera`) without a documented justification.
22+
- **Skills recommending insecure practices** (running `eval()` on driver expressions from untrusted sources, disabling Blender's auto-execute-script protection in headless workflows, embedding credentials in `.blend` custom properties).
23+
- **Headless batch scripts** that pass user-controlled input to `subprocess` or `os.system` without sanitization.
24+
25+
Issues with the Blender Python API itself (`bpy`, `bmesh`, `bpy_extras`) belong upstream at https://projects.blender.org and are out of scope here.
26+
27+
## Supported Versions
28+
29+
| Version | Supported |
30+
|---------|-----------|
31+
| 0.1.x | Yes |
32+
| < 0.1.0 | No |
33+
34+
## Response Timeline
35+
36+
We aim to acknowledge reports within 48 hours and provide a fix or mitigation within 7 days for confirmed issues.

0 commit comments

Comments
 (0)