MetroCS / cs3250_practice

Practice repository for cs3250
1 stars 29 forks source link

[USER-STORY] Maintainer - Coding Convention #129

Open jody opened 1 week ago

jody commented 1 week ago

User Story

Story

As a Maintainer
I want to know the coding conventions that apply to this project
so that I can contribute appropriately to the product.

Acceptance Criteria

Rules

Supporting Information

[Relevant information, context, resources, references]

Dependencies

Depends On

[Links to other issues on which this story depends]

Dependents

[Links to other issues that depend on this story]

84

jody commented 1 week ago

Does the first rule in the acceptance criteria already exist in the Coding Convention Guide?

In addition, the build.xml script appears to address the second rule.

Maybe all that's needed is to document the use of ant checkstyle (already part of ant all).