Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[USER-STORY] Maintainer - Coding Convention #129

Open
jody opened this issue Nov 7, 2024 · 1 comment
Open

[USER-STORY] Maintainer - Coding Convention #129

jody opened this issue Nov 7, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation E: 2 Effort: 2 Story-Points S: Significant Severity: Significant - in the mainline plan user story User Story

Comments

@jody
Copy link
Contributor

jody commented Nov 7, 2024

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

  • Coding conventions are identified in contributor documentation
  • Means to verify adherence to coding conventions are documented

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 jody added the triage Needs triage label Nov 7, 2024
@jody jody added documentation Improvements or additions to documentation user story User Story E: 2 Effort: 2 Story-Points S: Significant Severity: Significant - in the mainline plan and removed triage Needs triage labels Nov 7, 2024
@jody jody moved this from Backlog to Ready in CS3250 Decision Support Project Nov 7, 2024
@jody
Copy link
Contributor Author

jody commented Nov 7, 2024

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation E: 2 Effort: 2 Story-Points S: Significant Severity: Significant - in the mainline plan user story User Story
Projects
Status: Ready
Development

No branches or pull requests

1 participant