scottbez1 / scottbez1/splitflap

Generate image artifacts for various tools

Open
#161 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: tooling type: enhancement
Dominant language
JavaScript
Stars
4.1k
Forks
344
PR merge metrics
No merged PRs in 30d

Description

We're starting to collect a variety of 3d models for optional tools/accessories, outside of the primary model, so it would be great to start building some artifacts from them in CI to

  1. make sure they don't accidentally break as the designs change
  2. provide images to reference from a README tool directory, along with brief descriptions of what they are, how they can be used, and how they can be customized

Ideally each tool would specify its preferred camera settings within the .scad file (rather than keeping this elsewhere in either a python script or Actions yaml file) since it's tightly coupled to the 3d model.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the optional tool .scad files, the existing Python image-generation path, and the GitHub Actions YAML used for CI. Define how each model supplies camera settings, then confirm that CI produces image artifacts and that the README tool directory includes descriptions of use and customization.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.