Closed AragornIISOA closed 2 years ago
How are we to measure "more clear" in order to determine whether this user story is satisfied by a solution?
Suggested Change: Under the 'I Want' section of the 'Story' section, It could be updated to say "I want...the readme to clearly communicate that contributing.md contains information on Contributing, Technologies, and Tools and to have access to the contributing.md in a prominent place in said readme." Suggested Change 2: Under the Acceptance Criteria, add Rule 2: "Contributing.md is in a prominent place, easily accessible to newcomers.
Would this issue be satisfied by simply moving the last sub-bullet from the current README into the Contributing document?
Here are quick mock-ups showing the README without the confusing extra sub-bullet and the Contributing document with a link to the conventions document.
README.md
Contributing.md
User Story
Essential components
Story
As a User, Maintainer
I want The contributing section of the readme to be more clear
so that when we're looking for information on contributing, tools, and technologies, it's simpler
Acceptance Criteria
(Rules or scenarios are acceptable formats.)
Scenario 1
Given the contributing link is more clear
when someone is looking for information on tools and technologies as well
then such a person would be able to find what they're looking for easier
Supporting Information
The information found in the Contributing.md section also tells users/maintainers what technologies and tools are used. This is related to
4
Dependencies
Depends On
Dependents