diff --git a/.github/DISCUSSION_TEMPLATE/show-and-tell.yml b/.github/DISCUSSION_TEMPLATE/show-and-tell.yml new file mode 100644 index 0000000..08aa2eb --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/show-and-tell.yml @@ -0,0 +1,38 @@ +title: "Stitch-out: " +labels: [] +body: + - type: markdown + attributes: + value: | + Thanks for sharing! Real stitch-outs are the best test OpenStitch can get. Good and bad results are both useful. + - type: textarea + id: photo + attributes: + label: Photo of the stitch-out + description: Drag one or more photos in here. A close-up of problem spots helps. + validations: + required: true + - type: input + id: machine + attributes: + label: Machine and file format + placeholder: "Brother PE800, PES" + validations: + required: true + - type: input + id: fabric + attributes: + label: Fabric, stabilizer, needle + placeholder: "T-shirt jersey, cut-away, 75/11 ballpoint" + - type: textarea + id: result + attributes: + label: What went right, what went wrong? + placeholder: "Lettering clean, but the fill pulled in about 1 mm on the left." + validations: + required: true + - type: input + id: version + attributes: + label: OpenStitch version + placeholder: "0.4.0" diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..a76948d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,65 @@ +name: Bug report +description: Something went wrong, crashed, or stitched differently than expected. +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time! The more precise the steps, the faster it gets fixed. + A problem that only shows up on fabric is a bug too: a photo of the stitch-out helps a lot. + - type: textarea + id: what + attributes: + label: What happened? + description: What did you do, what did you expect, and what happened instead? + placeholder: "I auto-digitized a logo, pressed F7, and the program closed." + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Numbered steps, starting from opening OpenStitch. + placeholder: | + 1. Open OpenStitch + 2. File, Open, choose logo.png + 3. ... + validations: + required: true + - type: input + id: version + attributes: + label: OpenStitch version + description: The release you downloaded, for example 0.4.0. If unsure, the date you downloaded it. + placeholder: "0.4.0" + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating system + options: + - Windows + - macOS (Apple chip) + - macOS (Intel) + - Linux + validations: + required: true + - type: input + id: machine + attributes: + label: Embroidery machine and file format (if it is about stitching) + placeholder: "Brother PE800, PES" + - type: textarea + id: files + attributes: + label: Files, photos, screenshots + description: Drag files in here. The image you started from or your design makes it much easier to reproduce. GitHub only accepts some file types, so put .ostitch, .pes or .dst files into a ZIP first. + - type: textarea + id: log + attributes: + label: Error message or crash report + description: | + If OpenStitch showed an error, paste its text here. After a crash it also writes `crash.log`: + Windows `%APPDATA%\OpenStitch`, macOS `~/Library/Application Support/OpenStitch`, Linux `~/.local/share/OpenStitch`. + render: text diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a8033c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Share a stitch-out + url: https://github.com/lb2002/openstitch/discussions/new?category=show-and-tell + about: Stitched something with OpenStitch? A photo and a sentence on what went right or wrong helps more than anything. + - name: Ask the community + url: https://github.com/lb2002/openstitch/discussions/categories/q-a + about: Questions others can answer too, and answers the next person can find. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..92e6002 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,33 @@ +name: Feature request +description: An idea or wish that would make OpenStitch more useful for you. +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Describe the problem you want solved, not only the button you imagine. Often there is a simpler way to get there. + Not sure yet? Start a conversation in [Ideas](https://github.com/lb2002/openstitch/discussions/categories/ideas) instead. + - type: textarea + id: problem + attributes: + label: What are you trying to do? + placeholder: "I stitch team names on caps and have to set every name by hand." + validations: + required: true + - type: textarea + id: idea + attributes: + label: What would help? + placeholder: "Import a list of names and create one file per name." + validations: + required: true + - type: textarea + id: today + attributes: + label: How do you do it today? + description: Other software, workarounds, or not at all. + - type: input + id: machine + attributes: + label: Your machine (if it matters) + placeholder: "Janome MB-7, JEF" diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..81777b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,24 @@ +name: Question +description: How do I ...? Something unclear in OpenStitch. +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Questions are welcome here. If you'd like others to chime in too, [Q&A in Discussions](https://github.com/lb2002/openstitch/discussions/categories/q-a) is often the better place, and answers there help the next person. + - type: textarea + id: question + attributes: + label: Your question + placeholder: "How do I make the satin border thicker without changing the fill?" + validations: + required: true + - type: textarea + id: tried + attributes: + label: What have you tried? + - type: input + id: setup + attributes: + label: OpenStitch version, operating system, machine + placeholder: "0.4.0, Windows 11, Brother PE800" diff --git a/site/index.html b/site/index.html index 97f05ba..1ef9787 100644 --- a/site/index.html +++ b/site/index.html @@ -20,6 +20,7 @@ OpenStitch Studio