[UserStory] _Project needs build instructions and supporting documentation_

[jody]

User Story

Essential components

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

Story

As a {developer | maintainer}
I want information about how to build the product
so that I can modify the product for my own use and as contribution to the project

Acceptance Criteria

• Steps to build the product are clearly stated and readily located in the repository
• Project conventions are clearly stated and readily located in the repository

Supporting Information

See similar MetroCS projects:

• Redistricting
  • Redistricting - Contributing
  • Redistricting - Development Conventions
• Quality Tools for BlueJ
  • QT4BJ Development Conventions

Related Issues

User Story #24

[nicolewelch]

Our team, coding collaborative, would like to claim this issue kweidner14 rdaniel58 MetalEng chrisreylo73

[jody]

I'm not positive, but I think that anyone who would also liked to be assigned to this issue just needs to make a comment from their own account. (GitHub won't allow me to assign any account that hasn't already shown interest... which is a policy that makes sense.)

[jody]

This issue seems related to issue #3

[chrisreylo73]

Can you elaborate on what you mean by "Project Conventions"? Our Team is a little confused on what that means.

[jody]

Can you elaborate on what you mean by "Project Conventions"? I am referring to information similar to that which is linked to in the Supporting Information section of this issue. Do you have a more specific question about those examples?