Skip to content

Commit 84edf4a

Browse files
author
William
committed
chore: improve ignore patterns and update documentation
Expand .dockerignore to exclude documentation files, build artifacts (*.step, *.3mf, *.stl), and temporary files for leaner Docker builds. Restructure .gitignore with categorized sections (Python, venvs, OS/editor, build artifacts) for better maintainability and clarity. Update Icons_SVG README with clearer naming conventions, guidelines, and usage documentation for the icon library.
1 parent f0543eb commit 84edf4a

43 files changed

Lines changed: 533 additions & 7443 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.dockerignore‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
.git
22
.gitignore
3+
.gitattributes
4+
.editorconfig
35
.claude
46
Screenshots
57
README.md
8+
CONTRIBUTING.md
9+
SECURITY.md
10+
CODE_OF_CONDUCT.md
11+
CHANGELOG.md
12+
SUPPORT.md
13+
THIRD_PARTY_NOTICES.md
14+
docs
15+
dev
616
debug_stl.py
717
gridfinity_bin_label.scad
818
label_generator.scad
919
*.zip
1020
*.stl
1121
*.log
22+
*.step
23+
*.3mf
24+
failed*.svg
1225
__pycache__
1326
*.pyc
1427
*.pyo
28+
tmp

‎.editorconfig‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
root = true
2+
3+
[*.py]
4+
indent_style = space
5+
indent_size = 4
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.{js,css,html,md,yml,yaml}]
12+
indent_style = space
13+
indent_size = 4
14+
charset = utf-8
15+
end_of_line = lf
16+
insert_final_newline = true
17+
trim_trailing_whitespace = true
18+
19+
[*.{bat,ps1}]
20+
end_of_line = crlf

‎.gitattributes‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
* text=auto eol=lf
2+
3+
*.bat text eol=crlf
4+
*.ps1 text eol=crlf
5+
6+
*.png binary
7+
*.jpg binary
8+
*.jpeg binary
9+
*.gif binary
10+
*.ico binary
11+
*.ttf binary
12+
*.woff2 binary
13+
*.stl binary
14+
*.step binary
15+
*.3mf binary
16+
*.zip binary
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Report a reproducible defect
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
## Summary
10+
Describe the issue clearly.
11+
12+
## Environment
13+
- OS:
14+
- Browser:
15+
- App commit/version:
16+
17+
## Steps to Reproduce
18+
1.
19+
2.
20+
3.
21+
22+
## Expected Behavior
23+
24+
## Actual Behavior
25+
26+
## Screenshots / Logs
27+
Attach screenshots and relevant console/server logs.
28+
29+
## Additional Context
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Propose an improvement
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
## Problem Statement
10+
What pain point are you solving?
11+
12+
## Proposed Solution
13+
14+
## Alternatives Considered
15+
16+
## Additional Context
17+
Screenshots, mockups, workflows, etc.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Summary
2+
Describe what changed and why.
3+
4+
## Type of Change
5+
- [ ] Bug fix
6+
- [ ] Feature
7+
- [ ] Refactor
8+
- [ ] Docs
9+
- [ ] Other
10+
11+
## Validation
12+
- [ ] Tested locally
13+
- [ ] Export flows checked (`3MF`, `STEP`, `SVG`) when relevant
14+
- [ ] JSON import/export checked when relevant
15+
- [ ] UI checked on mobile + desktop when relevant
16+
17+
## Screenshots (if UI changed)
18+
19+
## Notes

‎.gitignore‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
/.claude
1+
# Local tooling
2+
/.claude/
3+
4+
# Python
5+
__pycache__/
6+
*.py[cod]
7+
*.pyd
8+
.pytest_cache/
9+
.ruff_cache/
10+
.mypy_cache/
11+
12+
# Virtual environments
13+
.venv/
14+
venv/
15+
env/
16+
17+
# Environment files
18+
.env
19+
.env.local
20+
21+
# OS / editor
22+
.DS_Store
23+
Thumbs.db
24+
.vscode/
25+
.idea/
26+
27+
# Build / generated artifacts
28+
tmp/
29+
*.log
30+
*.zip
31+
*.step
32+
*.stl
33+
*.3mf
34+
failed*.svg
35+
test_scale.svg
36+
test_y_offset_output.txt
37+
38+
# Local experiments / scratch
39+
tmp_old_app*.js
40+
sonarr.db

‎3MF_COLORING_HANDOFF.md‎

Lines changed: 0 additions & 132 deletions
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on Keep a Changelog and this project follows Semantic Versioning where practical.
6+
7+
## [Unreleased]
8+
### Added
9+
- Public project docs baseline:
10+
- `README.md`
11+
- `CONTRIBUTING.md`
12+
- `SECURITY.md`
13+
- `CODE_OF_CONDUCT.md`
14+
- `SUPPORT.md`
15+
- `LICENSE`
16+
- `docs/README.md`
17+
- Community templates:
18+
- `.github/ISSUE_TEMPLATE/bug_report.md`
19+
- `.github/ISSUE_TEMPLATE/feature_request.md`
20+
- `.github/PULL_REQUEST_TEMPLATE.md`
21+
- Repository standards files:
22+
- `.editorconfig`
23+
- `.gitattributes`
24+
25+
### Changed
26+
- Dashboard UX improvements (sticky top action dock + fixed bottom batch export dock).
27+
- Batch export controls and status presentation.
28+
- Tag editor UX improvements (compact selectors, inline zone editor).
29+
30+
### Removed
31+
- Legacy scratch/temporary files from repository root.

‎CODE_OF_CONDUCT.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
We are committed to making participation in this project a harassment-free experience for everyone.
5+
6+
## Expected Behavior
7+
- Be respectful and constructive.
8+
- Assume good intent.
9+
- Give actionable feedback.
10+
- Focus on ideas and implementation, not individuals.
11+
12+
## Unacceptable Behavior
13+
- Harassment, discrimination, or personal attacks.
14+
- Trolling or intentionally disruptive behavior.
15+
- Publishing private information without consent.
16+
17+
## Enforcement
18+
Project maintainers may remove, edit, or reject comments, commits, issues, and other contributions that violate this Code of Conduct.
19+
20+
## Reporting
21+
If you experience or witness unacceptable behavior, report it privately to the maintainers. Reports will be reviewed and handled as promptly as possible.

0 commit comments

Comments
 (0)