github/github-artifact-exporter

Write up GUI package README

Open

#1 opened on Sep 4, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)TypeScript (23 forks)github user discovery
documentationgood first issuehelp wanted

Repository metrics

Stars
 (282 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Our GUI package is lacking a comprehensive README file.

TODOs

  • Add screen shots section
  • Add contribute or developers sections with build instructions
  • Optional Add a Gif showing off the usage of the application

Contributor guide

Research direction
Review the GUI package source and usage to document features, screenshots, and build instructions accurately.
Tech stack
typescript
Domain
frontenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90