DesignSafe-CI / DesignSafe-CI/DS-User-Guide
Detailed "How to Contribute" Doc, Like Use Case's
Nobody has claimed this yet.
- Dominant language
- Tcl
- Stars
- 1
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Overview
Promote Use Cases README.md to be a deep-dive "edit anything" doc.
Obstacles
The Use Cases README.md has the following sections —
3. Find Usecase
…
4. Edit Usecase
…
6. Add Images
…
12. Add Use Case New to User Guide
— and references like "your use case" and "your usecase.md file".
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
Start with user-guide/docs/usecases/README.md, which the issue identifies as the source document. Review its sections on finding, editing, adding images, and adding a new use case, then adapt the guidance so it applies to contributing more generally. Done means the document provides a detailed, non-use-case-specific contribution workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100