bcgov/nr-sustainment-capstone-2024

Create Wiki entry for Consistent Documentation Rules

Open

#115 opened on May 29, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (2 forks)auto 404
DocumentationTaskhelp wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the task

As a QuackStack Developer I want a wiki page So That we can reference a single source to maintain consistency throughout the projects documents.

Acceptance Criteria

e.g. Given (Context), When (Action carried out), Then, (expected outcomes)

  • Names and project specific terms are defined in the document

Additional context

  • Add any other context about the task here.

Contributor guide

Research direction
Explore the repository's wiki space, review existing documentation, and identify project specific terms and naming conventions to define.
Tech stack
typescript
Domain
documentation
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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90