Thank you for your interest in contributing to BambuForge! We welcome parametric CAD contributions, slicing profile enhancements, agent skill expansions, and documentation improvements.
- Branch Protection: The
mainbranch is strictly protected. Direct pushes tomainare blocked. - Single Approver Gatekeeper: All contributions must be submitted via Pull Requests. Explicit code ownership across all components is governed by
.github/CODEOWNERS. Only the repository maintainer (@mlgitdev) has permission to review, approve, and merge PRs intomain. - Force PR Merge Authority: Only
@mlgitdevpossesses administrative override / force PR merge authority (gh pr merge --admin --squash). - Required Automated Checks:
PR Validation Bot: Conventional commit title standard and complete template checklist.Secret Scanning & Privacy Audit: Zero PII (personal file paths or usernames) and zero high-entropy secrets.Multi-OS CI: Python compilation across Ubuntu, Windows, and macOS.
- Post-Merge Release Automation: Merges into
mainthat bumpVERSIONautomatically trigger the release pipeline, packagingBambuForge-vX.Y.Z.zipand.tar.gzdistribution archives.
Before writing code or parametric geometry, every contribution must have an active GitHub Issue:
- Search Existing Issues: Run
gh issue listor search the repository to confirm your proposal isn't already in flight. - Open an Issue: Use one of the structured templates:
- Bug Report (
fix:): For geometry intersections, slicer crashes, or script errors. - 3D Model Request (
feat(cad):): For new parametric parts, planters, or mechanical assemblies. - Skill Enhancement (
feat(skill):): For updates to autonomous agent prompts or workflow scripts.
- Bug Report (
- Reference in PR: The resolving PR must explicitly cite the issue (
Resolves #<issue-number>).
git clone https://github.com/mlgitdev/BambuForge.git
cd BambuForgegit checkout -b feat/your-feature-namepython -m venv .venv
# Windows:
.\.venv\Scripts\Activate.ps1
# Linux / macOS:
source .venv/bin/activate
pip install -r requirements.txtRun syntax checks and test CAD generation scripts:
# Compile all scripts
python -m compileall .
# Run test slicing / geometry generator
python .agents/skills/3d-print-modeling/scripts/planter_family_engine.pyEnsure no local system usernames, absolute user directories, or private tokens exist in any committed files:
python .agents/skills/bambuforge-repo-sync/scripts/sync_to_bambuforge.py --dry-runFollow Conventional Commits format:
git add .
git commit -m "feat(planter): add parametric chamfer reinforcement"
git push -u origin feat/your-feature-name
gh pr createCommit titles must strictly conform to Conventional Commits:
type(scope): description
feat: New parametric models, skills, or slicing capabilities.fix: Bug fixes, manifold repairs, clearance calibrations.docs: Documentation updates (README.md,SDD.md).refactor: Restructuring Python CAD scripts without changing output geometry.chore: Dependency updates,.gitignore, or repository configuration.
- Zero Hardcoded Paths: Never hardcode paths containing personal usernames or absolute drive letters. Use relative paths or
<WORKSPACE_ROOT>. - No Slicer Cache / Credentials: Never commit
.gcode, Bambu Studio cloud credentials, or API keys.