Coding and Development Standards - uiowaSEP2024/002_ImagePro GitHub Wiki

Code Reviews:

1 review required

Tools Used: Pycharm
Python version:3.10
Node version:20.11.1

def greeting(name: str) -> str:
    return 'Hello ' + name

def function(a, b):
    """Do X and return a list."""

issues:
- User Stories: The name is a short descriptive name. The description must follow the "As a ___, so that ___, I want ___" format and have acceptance criteria listed.
- Feature Implementations: Detail the technical requirements and implementations of an enhancement to the project, are tied to a user
  story. Must be pointed using the Fibonacci scale labels
- Chore: Fixes that are not associated to a specific user story but are updates that need to be done and documented
branches: Branch names should reflect the feature, bug, or task they're associated with, often including a type prefix and a short descriptor. Including an issue or task ID (if your project uses a tracker) can also be helpful for traceability.
PRs: Pull request titles should summarize the changes made, providing clear insight into what will be achieved by merging the PR. It's helpful to start with a type prefix, similar to branch naming, followed by a brief description of the change. Including the issue or task ID in the PR title can also enhance traceability and context.

ALL Commits must follow this template:

Prefix: Commit Stub

Commit message