-
Notifications
You must be signed in to change notification settings - Fork 79
Open
Labels
E: 2Effort: 2 Story-PointsEffort: 2 Story-PointsS: SignificantSeverity: Significant - in the mainline planSeverity: Significant - in the mainline plandocumentationImprovements or additions to documentationImprovements or additions to documentationuser storyUser StoryUser Story
Description
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:
- The project website, along with introductory text, appears at the top of ReadMe after the project overview.
- BlueJ user instructions appear in the user-oriented website page
- 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
Reactions are currently unavailable
Metadata
Metadata
Labels
E: 2Effort: 2 Story-PointsEffort: 2 Story-PointsS: SignificantSeverity: Significant - in the mainline planSeverity: Significant - in the mainline plandocumentationImprovements or additions to documentationImprovements or additions to documentationuser storyUser StoryUser Story
Type
Projects
Status
Done