jody
commented
1 month ago About the Story:
How is.
"I want a comprehensive guide on contributing to the project"
significantly different from.
"I want information about contributing to the project"?
It seems like "comprehensive" or "guide" or both are significant. But the distinction is unclear. This feels more like a restating of #65 rather than a sub-story of that epic. Please clarify.
About the Acceptance Criteria These seem to constrain the potential solutions without explaining why other solutions are not acceptable.
A document titled "Contribute to Our Project" exists in the project's repository under the /docs directory..
Why is that specific title necessary for the Maintainer? (Why would any other title not be acceptable?) Similarly, why is the only acceptable section heading "How to Contribute"? These seem to unnecessarily restrict acceptable solutions. (The user story and its acceptance criteria are expectede to describe what needs to be achieved, and allow the developers to determine how to achieve it.)
Similarly, why does the document need to reside in the /docs directory? Note that a /docs is used for the published website via the "website" branch.
Another aspect that seems over-constrained is that all of the information must be contained in the same file. That precludes solutions that organize the information into multiple, linked files.
User Story
Story
As a Maintainer
I want a comprehensive guide on contributing to the project
so that I understand how to effectively contribute and collaborate with other contributors.
Acceptance Criteria
Rules
/docsdirectory.Supporting Information
See similar documentation efforts in projects like "Contributing to the ImageLab Project" and "Contributing to the Redistricting Project."
Dependencies
Dependents
#65