Skip to content

[UserStory] Documentation for contributors is up-to-date with tools and conventions #80

@jody

Description

@jody

User Story

Essential components

  • Title describes the story
  • Stakeholder type is identified
  • Outcome is described
  • Rationale is explicit
  • Acceptance criteria are verifiable and from the perspective of the stakeholder

Story

As a contributor
I want the documentation for contributors to be up-to-date with respect to technologies, tools, and conventions
so that I and other contributors have the information needed to make maintainable contributions consistent with project expectations

Acceptance Criteria

  • The Contributing.md document lists all technologies applicable to the build process
  • The Contributing.md document lists all tools applicable to the build process
  • The Contributing.md document identifies all conventions applicable to project artifacts
  • The Contributing.md document identifies all conventions applicable to project contribution processes

Supporting Information

Dependencies

Depends On

none

Dependents

none

Metadata

Metadata

Assignees

No one assigned

    Labels

    S: SignificantSeverity: Significant - in the mainline plandocumentationImprovements or additions to documentationepicEpic User Storyuser storyUser Story

    Type

    No type

    Projects

    Status

    To do

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions