Brautigancody465 commented 1 month ago

User Story

Story

As a MAINTAINER
I want instructions to include pseudo code so that we can build it with any language.

Acceptance Criteria

pseudo code cannot contain any syntax specific to any language.
pseudo code must contain all features and functions of the product.
pseudo code must be easy to comprehend in layman's vocabulary.
pseudo code must be updated to be an accurate reflection of the products source code.

Scenario 1

Given A new worker is hired on
when they need to fix or add a new feature to our product
then They should be able to look at the pseudo code and understand exactly where to inject their changes.

Dependencies

Depends On

64

Dependents

jody commented 1 month ago

Is #64 meant to be a dependent of this issue? That is, does #64 depend on this issue being resolved?

I find the references a bit confusing. Specifically:

The phrase "instructions to include pseudo code"
The suggestion to "build it with any language"

The instructions in #64 are focused on how to build the product, which uses Ant as the build tool and Java as the implementation language. That epic also links to similar instructions from another project.

Could you please provide an example of pseudo-code for the build instructions?

The acceptance criteria appear to address specification or design rather than actual instructions for building the product. It also appears to presume a context in which new workers are hired. Since this is an open-source project, we expect a range of potential contributors.

There might be some ambiguity surrounding the term "build." In this context, "building" refers to compiling and creating a runnable version of the software, transforming source code into an executable file for testing and eventual deployment.

As currently written, this doesn't seem essential for epic #64