IQSS / IQSS/dataverse-frontend

[Docs] Developer Guide

Open
#304 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

SPA: Documentation UI
Dominant language
TypeScript
Stars
31
Forks
26
Avg merge
4d 13h
Merged PRs (30d)
4

Description

In addition to the general Frontend Guide, having some dev-specific documentation for extending the existing SPA will likely be useful. Breakdown of architecture design methodology, writing test-cases, using storybook, etc.

Will update as requirements evolve

Contributor guide

Open the contributing guide

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 with the existing Frontend Guide and review how the SPA currently documents architecture, test-case writing, and Storybook usage. A developer guide is done when it clearly covers those extension workflows and can be updated as requirements evolve.

Written by the indexing model from the issue text.

Assessment

Tech stack
storybook, typescript
Domain
documentation, frontend
Issue type
Documentation
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.