DesignSafe-CI / DesignSafe-CI/DS-User-Guide
How Best to Offer Screenshots?
Open
Nobody has claimed this yet.
2024-08
question
- Dominant language
- Tcl
- Stars
- 1
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Questions
-
Should the use cases with outdated screenshots (#267) use screenshots?
-
If so, should they be images, videos or
.gifs?option evaluation image easy to make and work with, easiest to update video more time, larger file, time-consuming to update .gifuncertain how to create, less easy to update
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the outdated screenshot issue (#267) and the questions here about images, videos, and .gifs. Determine which screenshot format the user guide should support and document the project’s chosen guidance; the issue does not name files or tests to run.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100