Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/function-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Function request
description: Propose a new capability or workflow for the Studio.
title: "[Function]: "
body:
- type: markdown
attributes:
value: |
Describe the user need first, then the function that could address it. Please keep proposals consistent with the Studio's privacy and SVG-safety boundaries.

- type: textarea
id: need
attributes:
label: User need
description: What BUG or workflow would this new function address?
placeholder: As a profile author, I want to...
validations:
required: true

- type: textarea
id: function
attributes:
label: Proposed function
description: Explain how it should work from a user's perspective.
validations:
required: true

- type: textarea
id: example
attributes:
label: Example
description: Show a sample input/output, user flow, or acceptance criteria.
placeholder: |
Given...
When...
Then...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Describe current workarounds or other possible solutions.

- type: textarea
id: context
attributes:
label: Additional context
description: Add mockups, links to related issues, accessibility needs, security considerations, or compatibility constraints.

- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched the existing issues for the same or a similar request.
required: true
- label: The request does not require arbitrary CSS, SVG markup, SVG paths, scripts, or remote fonts.
required: true
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Improvement proposal
description: Suggest a better version of existing behavior, design, or documentation.
title: "[Improvement]: "
body:
- type: markdown
attributes:
value: |
Use this form when something already exists but could work better. For entirely new behavior, use the function request form.

- type: textarea
id: current
attributes:
label: Current experience
description: What currently works, and where does it fall short?
placeholder: The export warning identifies the affected field, but it does not explain how to correct it.
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed improvement
description: Describe the change and include a concrete example when possible.
validations:
required: true

- type: textarea
id: benefit
attributes:
label: Benefit
description: Who would benefit, and how would this improve their workflow?
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Note any workarounds or other approaches you considered.

- type: textarea
id: context
attributes:
label: Additional context
description: Add mockups, screenshots, related issues, accessibility considerations, or compatibility constraints.

- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched the existing issues for a similar proposal.
required: true
- label: This proposal improves existing behavior rather than introducing an entirely new function.
required: true
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/problem-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: BUG report
description: Report something that is broken or behaves unexpectedly.
title: "[BUG]: "
body:
- type: markdown
attributes:
value: |
Thanks for helping improve Animated GitHub Profile Studio. Please search existing issues before submitting a report.

- type: textarea
id: BUG
attributes:
label: BUG
description: Describe what went wrong and what you were trying to do.
placeholder: I selected the mobile preview, but the exported SVG...
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: Give the smallest reliable sequence that shows the BUG.
placeholder: |
1. Open the Studio.
2. Select the Bento Grid template.
3. Change the preview to mobile and static.
4. Select Download SVG.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: What should have happened instead?
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Include the browser, operating system, app version or commit, and whether you used the hosted or local Studio.
placeholder: Chrome 140, Windows 11, hosted Studio
validations:
required: true

- type: textarea
id: evidence
attributes:
label: Additional evidence
description: Add screenshots, exported configuration, console errors, or other useful context. Remove personal or sensitive data first.

- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched the existing issues for the same BUG.
required: true
- label: I removed tokens, private data, and other sensitive information.
required: true
43 changes: 43 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## Summary

<!-- Explain what changed and why. Keep this focused on the user-visible or technical outcome. -->

Example: Fix mobile static exports so they use the selected responsive composition.

## Related issue

<!-- Use "Closes #123" when merging this pull request should close an issue. Use "None" when there is no related issue. -->

Closes #

## Type of change

- [ ] BUG fix
- [ ] Improvement to existing behavior
- [ ] New function
- [ ] Documentation or maintenance

## Verification

<!-- List the checks you ran and any important manual scenarios. Do not check a command that you did not run. -->

- [ ] `npm run typecheck`
- [ ] `npm test`
- [ ] `npm run build`
- [ ] Relevant desktop/mobile, dark/light, and animated/static variants were inspected

Additional verification:

<!-- Example: Imported a v2 config and confirmed that profile content and visual choices were preserved. -->

## Screenshots or generated output

<!-- Add before/after images or generated output for visual changes. Write "Not applicable" otherwise. -->

## Checklist

- [ ] I kept this pull request focused and avoided unrelated refactoring.
- [ ] I added or updated tests when behavior changed.
- [ ] I updated documentation when setup, configuration, or user-visible behavior changed.
- [ ] I did not add secrets, private data, unlicensed media, or unsafe raw CSS/SVG input.
- [ ] I preserved backward compatibility, or documented the intentional breaking change above.
2 changes: 1 addition & 1 deletion src/domain/profile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ export const defaultProfileConfig: ProfileConfig = {
profileLabel: "FICTIONAL / 01",
eyebrow: "FICTIONAL SAMPLE",
primaryRole: "Creative Developer",
secondaryRole: "Open-source builder / Problem solver",
secondaryRole: "Open-source builder / BUG solver",
},
hero: {
headline: ["Imagine it.", "Build it.", "Share it."],
Expand Down
Loading