Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
5 tasks done
jody opened this issue Sep 12, 2021 · 2 comments
Open
5 tasks done
Labels
documentation Improvements or additions to documentation epic Epic User Story S: Significant Severity: Significant - in the mainline plan user story User Story
Milestone

Comments

@jody
Copy link
Contributor

jody commented Sep 12, 2021

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

@jody jody added documentation Improvements or additions to documentation user story User Story epic Epic User Story S: Significant Severity: Significant - in the mainline plan labels Sep 12, 2021
@jody jody added this to the Fall 2021 - Release 1 milestone Sep 12, 2021
@tmill101
Copy link

tmill101 commented Oct 3, 2023

I would like to work on the ant documentation. See if the discussed snap manager install resolves launcher issues.

@jody
Copy link
Contributor Author

jody commented Dec 2, 2023

#201 remains "In Progress" for current contribution.
This issue is reverted back to "To Do" as unresolved epic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation epic Epic User Story S: Significant Severity: Significant - in the mainline plan user story User Story
Projects
Development

No branches or pull requests

2 participants