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] ReadMe updates from a User perspective. #117

Open
5 tasks done
elmattes opened this issue Oct 26, 2023 · 0 comments
Open
5 tasks done

[UserStory] ReadMe updates from a User perspective. #117

elmattes opened this issue Oct 26, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation E: 2 Effort: 2 Story-Points S: Significant Severity: Significant - in the mainline plan user story User Story

Comments

@elmattes
Copy link
Contributor

elmattes commented Oct 26, 2023

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 user
I want I want my landing on the GitHub repository page with README displayed to tell me how to get and use the product
so that I can use the product and do so appropriately.

Acceptance Criteria

Change ReadMe to give it more clarity for brand new and returning users to utilize and run the project.
Specific changes for the user:

  1. The project website, along with introductory text, appears at the top of ReadMe after the project overview.
  2. BlueJ user instructions appear in the user-oriented website page
  3. Command line user instructions no longer appear in the repository-level README. (The text surrounding the webpage link at the top of the page provides adequate context to make it clear that information appears on the webpage.)

Supporting Information

All user-relevant information should appear on the project's "website" page.

Dependencies

Dependents

#113

@elmattes elmattes added the user story User Story label Oct 26, 2023
@jody jody added documentation Improvements or additions to documentation E: 2 Effort: 2 Story-Points S: Significant Severity: Significant - in the mainline plan labels Oct 26, 2023
jody pushed a commit that referenced this issue Nov 2, 2023
Update readme to Close #113 #117 #118
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 E: 2 Effort: 2 Story-Points S: Significant Severity: Significant - in the mainline plan user story User Story
Projects
Status: Done
Development

No branches or pull requests

2 participants