Skip to content

Commit 5cdac95

Browse files
Committing LIF_TShirt_Sizing.md to /docs
LIFTShirtSizing.md for review to upload to docs folder of GH. <!-- Thank you for your pull request. Please review the requirements below. Bug fixes and new features should be reported on the issue tracker: https://github.com/lif-initiative/lif-core/issues Contributing guide: https://github.com/lif-initiative/lif-core/blob/main/docs/CONTRIBUTING.md Code of Conduct: https://github.com/lif-initiative/lif-core/blob/main/CODE_OF_CONDUCT.md --> ##### Checklist <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> - [ ] commit message follows commit guidelines (see commitlint.config.mjs) - [ ] tests are included (unit and/or integration tests) - [ ] all tests are successful - [ ] documentation is changed or added (in /docs directory) - [ ] code passes linting checks (`uv run ruff check`) - [ ] code passes formatting checks (`uv run ruff format`) - [ ] code passes type checking (`uv run ty check`) - [ ] pre-commit hooks have been run successfully - [ ] database schema changes: migration files created and CHANGELOG.md updated - [ ] API changes: base (Python code) documentation in `docs/` and project README updated - [ ] configuration changes: relevant folder README updated - [ ] breaking changes: added to MIGRATION.md with upgrade instructions and CHANGELOG.md entry ##### Type of Change <!-- Check all that apply --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update - [ ] Infrastructure/deployment change - [ ] Performance improvement - [ ] Code refactoring ##### Description of Change <!-- Provide a clear and detailed description of the change below this comment. Include: - What problem does this solve? - What is the solution? - Are there any side effects or limitations? - How should reviewers test this? --> ##### Related Issues <!-- Link to related issues using #issue_number --> Closes # [[add Github issue number]] ##### Testing <!-- Describe the testing you've done --> - [ ] Manual testing performed - [ ] Automated tests added/updated - [ ] Integration testing completed ##### Project Area(s) Affected <!-- Check all project areas affected by this change --> - [ ] bases/ - [ ] components/ - [ ] orchestrators/ - [ ] frontends/ - [ ] deployments/ - [ ] CloudFormation/SAM templates - [ ] Database schema - [ ] API endpoints - [ ] Documentation - [ ] Testing ##### Additional Notes <!-- Any additional information that reviewers should know -->
1 parent 36ccbc8 commit 5cdac95

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/LIF_TShirt_Sizing.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
**T-Shirt Sizing Guidelines**
2+
3+
This project uses t-shirt sizing to describe the relative scope and complexity of work items.
4+
5+
**Important:**
6+
T-shirt sizes do **not** represent time, hours, or delivery estimates.
7+
They are intended to help contributors understand scope and help maintainers prioritize work.
8+
9+
Sizing is based on:
10+
11+
* Functional change
12+
* Surface area of the codebase affected
13+
* Risks and unknowns
14+
* Required system understanding
15+
16+
**Size Definitions:**
17+
18+
| Size | Description |
19+
| :---- | :---- |
20+
| XS | Very small change with minimal impact (comments, configuration tweaks, typos). |
21+
| S | Small, self-contained change affecting a single function or component with low risk. |
22+
| M | Moderate change introducing new behavior within an existing module or feature area. |
23+
| L | Larger change spanning multiple components, modules or interfaces. May require coordination or design discussion. |
24+
| XL | Significant change affecting architecture, data models, APIs, or core workflows. High risk or uncertainty. |
25+
| XXL | Foundational or systemic change (major refactor, redesign, or new subsystem). Requires design review before implementation. |
26+

0 commit comments

Comments
 (0)