bcgov / bcgov/lcfs

LCFS - Update Table and Column Descriptions in SQLAlchemy Models

Open
#465 0 comments 0 reactions 0 assignees View on GitHub
Low Tech Debt
Dominant language
Python
Stars
6
Forks
6
Avg merge
2d 4h
Merged PRs (30d)
87

Description

**Description:** Our database schema, defined in SQLAlchemy models, lacks descriptive comments for tables and columns. This task is to update our models with clear, informative comments for each table and column, detailing their purposes, data types, and any special considerations. This enhancement aims to improve the understanding of our data model for developers and external database architects, facilitating easier navigation and comprehension.

**Purpose:** To improve documentation within the codebase, ensuring that the database schema is well-understood, which will aid in maintenance, development, and external consultation.

**Acceptance Criteria:**
- [ ] Add descriptive comments to all tables in the SQLAlchemy models, outlining their roles and usage.
- [ ] Update each column with comments that describe its purpose, data type, and constraints or relationships.
- [ ] Ensure all comments are clear, concise, and accurate.
- [ ] Documentation guidelines for maintaining table and column comments are updated or created.

**Additional context:**
- Coordinate with team members for insights on table and column functionalities.
- Adopt a standardized format for comments to ensure consistency across the schema.

Contributor guide

Open the contributing guide

Research direction

Locate the SQLAlchemy model definitions and inventory every table and column that needs a comment. Review any existing documentation guidelines and consult team members about unclear schema roles or relationships. Done means all tables and columns have clear, consistent comments and the guidelines for maintaining them are updated or created.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, sqlalchemy
Domain
database, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.