RuggeroVisintin / RuggeroVisintin/SparkEngineWebEditor

[FEATURE REQUEST] CI - Recommend attaching video/gifs to Release notes

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

Nobody has claimed this yet.

enhancement good first issue
Dominant language
TypeScript
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
At the moment, the release notes only contain text, which makes it difficult to contextualize what the new additions are to the editor

Describe the experience you'd like
The CI should detect a new feature being added and prompt to attach a brief video to be referenced in the release notes

Describe alternatives you've considered
The video could be converted to a GIF to be more storage-friendly and stored in the docs/assets folder

Additional context

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 CI workflow that produces release notes and inspect how release content is assembled. Check the docs/assets folder and determine how a video or GIF could be referenced; done means the CI identifies a new feature and prompts for media attached to the release notes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
ci-cd, documentation, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.