Group 5 - CodeStrike Alpha Sprint: Code Standards, sprint Tasks, and Plans

CodeStrike CodeStrike 墨衍会员 · AI 创作全网分发 墨衍智能分发 通过墨衍一键同步至各平台 可同步平台 CSDN微信公众号微博知乎掘金百家号博客园抖音小红书 你的文章也可以这样分发 墨衍会员 ¥399起/年,写一次发全网 我也要 + 加入社区

CodeStrike Alpha Sprint: Code Standards, Sprint Tasks, and Plans

ItemContent
CourseEE308FZ Software Engineering Class Community
Assignment RequirementsFifth Assignment — Alpha Sprint
Team NameCodeStrike (Group 5)
Project NameCampus Competition & Activity Community (竞伴校园)
Assignment GoalEstablish unified team code standards grounded in our actual monorepo stack, and define the Alpha Sprint (Nov 21 – Nov 28, 2026) scope, task breakdown, acceptance criteria, and 13-member collaboration plan prior to sprint execution.
Project LeaderZhaoyan Wang (832402220)
GitHub Organization26-SoftwareEngineering-CodeStrike
Code Repositorycode-strike (Alpha Sprint branch: sprint/alpha)
Other ReferencesAssignment 4 Prototype Blog, Assignment 3 SRS Repository

目录

  • CodeStrike Alpha Sprint: Code Standards, Sprint Tasks, and Plans
  • 1. Current Project Status Before the Sprint
  • 2. Team Code Standards
  • 2.1 Core Engineering Principles
  • 2.2 Repository Formatting & Editor Rules
  • 2.3 Frontend Standards (Modao Prototype + Vue 3 / TypeScript / uni-app / Element Plus)
  • 2.4 Backend Standards (Python 3.13 / FastAPI / SQLAlchemy 2 / MySQL 8.4)
  • 2.5 API Rules, Error Handling & Security
  • 2.6 Git Workflow, Branching & Commit Conventions
  • 3. Alpha Sprint Goals & Task Plan (Nov 21 – Nov 28, 2026)
  • 3.1 Sprint Objectives
  • 3.2 Task Breakdown, Priorities & Acceptance Criteria
  • 3.3 Eight-Day Sprint & Blog Cadence
  • 4. Team Organization & Alpha Sprint Division
  • Planned Workload Tiers & Evaluation
(Table of Contents)


1. Current Project Status Before the Sprint

Before the Alpha Sprint (2026-11-21 to 2026-11-28) begins, our repository 26-SoftwareEngineering-CodeStrike/code-strike has three existing branches:

BranchLatest CommitCurrent Progress
main5afd42b (2026-10-26)pnpm@11.24.0 monorepo setup containing apps/student-app, apps/admin-web, apps/server, and packages/api-contracts.
feature/assignment4-prototypeceac8ec (2026-10-28)Assignment 4 frontend prototype branch. Our UI prototype was designed in Modao (墨刀) and built into H5 pages (uni-app + Vue 3 + TypeScript) with verification scripts (scripts/verify-h5-*.mjs), currently using MockTransport for local data.
feature/backend-implementationc2b027b (2026-11-08)FastAPI + SQLAlchemy 2 + Alembic + MySQL 8.4 backend with 26 tables, 58 API paths / 78 operations, and 11 pytest test files; IMPLEMENTATION_REPORT.md records 64 passed / 0 failed / 0 skipped on MySQL 8.4.7.

Two practical points shape our Alpha Sprint scope:

1. Frontend and backend are not connected yet: Both apps/student-app and apps/admin-web still run on MockTransport and need to be wired to the FastAPI backend.

2. WeChat Mini-Program is still under ICP filing: Because the Mini-Program registration is still in progress, this sprint focuses on end-to-end integration for the H5 student client (pnpm dev:student:h5), Admin Web client (pnpm dev:admin), and FastAPI + MySQL backend, while keeping pnpm build:student:mp-weixin compiling cleanly.


2. Team Code Standards

2.1 Core Engineering Principles

To keep our TypeScript/Vue 3 frontend and Python/FastAPI backend easy to read and maintain across the team, we follow these practical rules:

Engineering AreaCodeStrike Monorepo Standard
Naming & SemanticsAvoid leading/trailing _ or $ in identifiers and prohibit pinyin-English mixing. Use clear English names across packages/api-contracts, Vue components, and Python modules (PascalCase classes/models/schemas, snake_case Python functions, camelCase JSON fields, UPPER_SNAKE_CASE constants).
Exceptions & TransactionsNever swallow exceptions silently, print raw stack traces, or return inside finally. FastAPI service.py owns explicit with session.begin() blocks with rollback on error; API errors return {code, message, details?}, and frontend StatePanel / Element Plus shows clear feedback.
Database & Query SafetyUse lowercase snake_case table/column names, primary keys on every table, unique indexes on business-unique fields, parameterized SQLAlchemy 2 queries (no SQL string concatenation), and Alembic migrations (alembic upgrade head). Avoid multi-table JOINs (>3 tables) and deep LIMIT pagination. (Note: Per SRS data-integrity rules, tables keep explicit foreign keys and generated unique-guard columns.)
Security & AuthorizationNever store plaintext secrets; hash passwords with salted PBKDF2-HMAC-SHA256 (600,000 iterations) and store bearer tokens as SHA-256 digests. Validate ownership and permissions server-side on every request (e.g., current-captain/active-member checks for sensitive contact endpoints).
Layout & CommentsUse spaces only (no Tabs), keep line width bounded, explain why rather than what in comments, and delete dead commented-out code. .editorconfig enforces UTF-8, LF, 2-space (TS/Vue) / 4-space (Python) indentation; ruff enforces line-length = 100.
Function Size & Input ChecksKeep functions focused on one task (target <= 50 lines, cyclomatic complexity <= 10), keep router.py and Vue pages thin, validate all external payloads with Pydantic v2 / TypeScript types at API boundaries, and return 503 when required env config is missing.

2.2 Repository Formatting & Editor Rules

Enforced by root .editorconfig:

Encoding & Line Endings: charset = utf-8, end_of_line = lf, insert_final_newline = true.

Indentation: 2 spaces for TypeScript, JavaScript, Vue, JSON, YAML, and CSS/SCSS; 4 spaces for all Python files (*.py).

Trailing Whitespace: trim_trailing_whitespace = true for code files (false for *.md).

2.3 Frontend Standards (Modao Prototype + Vue 3 / TypeScript / uni-app / Element Plus)

1. Prototype Alignment: UI layouts and interaction states follow our Modao (墨刀) prototype; keep components synchronized when adjusting views.

2. Workspace & Type Safety: Use pnpm@11.24.0 workspace commands; all shared DTOs and enums must be imported from @codestrike/contracts (packages/api-contracts), never duplicated locally. Zero TypeScript errors allowed before commit: pnpm type-check (vue-tsc --noEmit for student-app, vue-tsc -b for admin-web and contracts) must pass.

3. Component & Page Organization: apps/student-app/src/components/ holds reusable UI primitives (CsHeader.vue, CsBottomNav.vue, CompetitionCard.vue, RecruitmentCard.vue, StatePanel.vue, StatusBadge.vue). Pages under apps/student-app/src/pages/ must remain thin view containers delegating data fetching to src/api/. Use <script setup lang="ts"> with explicit defineProps<...>() and defineEmits<...>() types; avoid any.

4. Transport Abstraction: Keep Transport interface clean so MockTransport (offline demo) and HttpTransport (FastAPI /api/v1) can be switched via environment configuration without altering view components.

5. Cross-Platform (H5 & mp-weixin) Discipline: Avoid browser-only globals (window, document) directly inside shared student-app pages/components; isolate platform-specific APIs or use uni.* wrappers so pnpm build:student:mp-weixin stays green.

2.4 Backend Standards (Python 3.13 / FastAPI / SQLAlchemy 2 / MySQL 8.4)

1. Style & Linting (ruff): Configured in apps/server/pyproject.toml with target-version = "py313" and line-length = 100. Follow PEP 8 naming (snake_case for functions/variables/modules, PascalCase for classes/Pydantic schemas/SQLAlchemy models, UPPER_SNAKE_CASE for constants) and include full Python 3.13 type annotations on all router handlers, service methods, and helpers.

2. Modular Monolith Structure (apps/server/app/modules/<domain>/): Each domain module (auth, competitions, content, teams, moderation, notifications, planner) separates router.py (FastAPI routes, OpenAPI metadata, dependency injection), schemas.py (Pydantic v2 request/response models), models.py (domain enums/helpers, with core ORM tables in app/db/models.py), and service.py (transactional business logic).

3. Database & Timezone Rules: Use MySQL 8.4 with InnoDB and utf8mb4. Normalize backend timestamps without explicit offsets to UTC; planner course/timed-plan schedules preserve local wall-clock values. Every schema change requires a versioned Alembic migration verified by alembic upgrade head and alembic check.

2.5 API Rules, Error Handling & Security

API Versioning: All endpoints live under /api/v1.

Auth Header: Protected endpoints require Authorization: Bearer <accessToken>.

Error Format: Return { "code": "...", "message": "...", "details": ... } with proper HTTP status codes (400, 401, 403, 404, 409, 422, 503). Never fake success when external dependencies (e.g., SMTP) are unconfigured (503).

Image Upload Bounds: Enforce PNG/JPEG validation, max 9 images per post, and max 5 MiB per image.

2.6 Git Workflow, Branching & Commit Conventions

1. Branch Strategy: main holds the stable phase baseline; sprint/alpha serves as the Alpha Sprint integration branch (combining feature/assignment4-prototype and feature/backend-implementation on Day 1); task branches use feat/<issue-id>-<short-slug> or fix/<issue-id>-<short-slug> and merge back to sprint/alpha via Pull Request after self-check and peer review.

2. Commit Message Format (Conventional Commits): Use <type>(<scope>): <subject> (#<issue>) with allowed types feat, fix, docs, style, refactor, test, chore. Every development commit during the sprint must reference its corresponding GitHub Issue number.

3. Hygiene: Never commit .env, .venv/, .test-venv/, node_modules/, dist/, or raw database dumps.


3. Alpha Sprint Goals & Task Plan (Nov 21 – Nov 28, 2026)

3.1 Sprint Objectives

1. Unify Codebase Baseline: Integrate the Assignment 4 frontend prototype (feature/assignment4-prototype) and FastAPI/MySQL backend (feature/backend-implementation) onto sprint/alpha.

2. Connect Core End-to-End Flows (H5 + Admin Web + FastAPI): Replace MockTransport on priority user journeys with real HttpTransport calls against MySQL 8.4, covering authentication & profile/skills management, competition discovery/submission, team creation/recruitment/application/captain review, community posts/comments/moderation, and notifications/personal planner.

3. Automated & Integration Testing: Maintain 100% pass rate on backend pytest (SQLite + MySQL 8.4), run frontend type-check/build and H5 verification scripts, and add API-to-UI integration verification.

4. Deliverables & Documentation: Publish all required Alpha Sprint blogs on schedule (4 Sprint Essays, 1 Testing Essay, 1 Sprint Summary Essay, 1 Topical Collection Essay) with verifiable burn-up charts, commit/issue evidence, and live screenshots.

3.2 Task Breakdown, Priorities & Acceptance Criteria

Task IDPriorityModuleTask DescriptionAcceptance Criteria
T1P0Baseline MergeMerge feature/assignment4-prototype and feature/backend-implementation into sprint/alpha; verify pnpm type-check, pnpm build:student:h5, pnpm build:admin, and pytest.Clean build and baseline test pass on sprint/alpha with reproducible setup docs.
T2P0Shared Types & HTTP ClientExpand packages/api-contracts types and implement HttpTransport with Bearer token management and error mapping for student-app and admin-web.Both clients support switching between MockTransport and HttpTransport via env config.
T3P0Auth & Profile IntegrationConnect registration, login, logout, current user (/auth/me), and profile/skills (/profiles/me, /skills) in H5 student client.Real user can register, log in, persist token, and update profile/skills in MySQL.
T4P0Competitions & Teams IntegrationConnect competition list/detail, team creation, recruitment list/detail, application submission, and captain review/admission flows.Full team recruitment -> apply -> captain approve/reject flow works end-to-end against MySQL, respecting capacity & privacy rules.
T5P1Community Posts & InteractionsConnect competition community posts, comments, likes/favorites, and image upload/preview (/competitions/{id}/posts, /posts/{id}/interactions/{kind}).Users can publish posts, comment, and toggle likes/favorites persisted in MySQL.
T6P1Admin Web IntegrationImplement HttpTransport for apps/admin-web covering /dashboard, competition management (/admin/competitions), and content/recruitment moderation.Admin can log in, view real dashboard counts, and approve/reject/remove pending revisions.
T7P1Notifications & Planner IntegrationConnect recipient notifications (/notifications) and personal planner (/planner/items, /planner/day, /planner/week) in H5 client.Notifications reflect admission/moderation events; planner CRUD persists across reloads.
T8P0Testing & QA AutomationExpand automated API + UI verification, run MySQL 8.4 concurrency/integrity tests, execute manual regression checklist, and capture test reports.Zero P0/P1 defects open; full test report and automated test metrics documented in Testing Essay.
T9P1MP-Weixin Build Check & DocsVerify pnpm build:student:mp-weixin compiles cleanly while ICP filing completes; maintain sprint logs, burn-up data, and bilingual blog drafts.mp-weixin dist builds without error; all 8 blogs published and submitted before Nov 29 23:59.

3.3 Eight-Day Sprint & Blog Cadence

DateSprint DayPlanned Engineering FocusBlog Deliverable
Nov 21Pre-Sprint / Day 1Finalize code standards & sprint plan; merge baseline branches onto sprint/alpha; create GitHub Issues.Code Standards, Sprint Tasks & Plans Essay (publish before sprint execution)
Nov 21 – Nov 22Day 1 – Day 2T1, T2, T3: Baseline integration, HttpTransport foundation, Auth & Profile E2E wiring.Sprint Essay 1 (Nov 22 evening)
Nov 23 – Nov 24Day 3 – Day 4T4: Competitions, teams, recruitment, applications & captain review E2E wiring + API tests.Sprint Essay 2 (Nov 24 evening)
Nov 25 – Nov 26Day 5 – Day 6T5, T6: Community posts/comments, Admin Web dashboard & moderation wiring.Sprint Essay 3 (Nov 26 evening)
Nov 27 – Nov 28Day 7 – Day 8T7, T8, T9: Notifications, planner, full MySQL + H5 regression, mp-weixin build check, bug fixes.Sprint Essay 4 (Nov 28) + Testing Essay
Nov 29Wrap-up (Before 23:59)Collect member reflections & verified workload distribution; finalize links.Sprint Summary Essay + Topical Collection Essay (submit before 23:59)

4. Team Organization & Alpha Sprint Division

Our 13-member team follows an "Overall Lead + Group Leads" structure across 5 functional groups (with cross-group roles where needed). Zhaoyan Wang (832402220) serves as Overall Project Lead, responsible for coordination, task assignment, schedule tracking, and final acceptance. Group members assist their respective group leads and take on specific sprint slices:

GroupGroup LeadMembersAlpha Sprint Responsibilities
Frontend Dev (4)Quanyan Tan (832402218)Jianhao Liu (832402216), Zhiqiang Wu (832402224), Maoping Wu (832402221)Quanyan Tan leads frontend integration and HttpTransport (T2, T4); Jianhao Liu assists with team creation, recruitment, and application pages (T4); Zhiqiang Wu assists with community post/interaction pages (T5); Maoping Wu assists with profile/skills wiring (T3).
Backend Dev (4)Guanxin Lai (832402211)Yu Lei (832402212), He Huang (832401308), Zhaoyan Wang (832402220)Guanxin Lai leads backend alignment for teams, admission, and moderation (T4, T6); Yu Lei assists with auth, email verification, and profile APIs (T3); He Huang assists with competition, community, notification, and planner APIs (T5, T7); Zhaoyan Wang assists with API integration and baseline merge (T1).
Product Design & Testing (3)Maoping Wu (832402221)Zhengyang Wu (832402223), Zhaoyuan Zhang (832402227)Maoping Wu leads prototype alignment and functional acceptance; Zhengyang Wu assists with competition/community test cases and regression checks (T8); Zhaoyuan Zhang assists with team matching, capacity, and deadline edge-case testing (T8).
Ops & Testing (3)Haogang Huang (832402209)Haochen Huang (832402208), Guanxin Lai (832402211)Haogang Huang leads Git workflow, test environment setup, and integration testing (T1, T8); Haochen Huang assists with automated test runs, bug logging, and test reports (T8); Guanxin Lai assists with MySQL and backend deployment checks.
Docs & Presentation (3)Zhaoyan Wang (832402220)Zihan Lin (832402215), Quanyan Tan (832402218)Zhaoyan Wang coordinates sprint blogs and task tracking; Zihan Lin assists with README updates, sprint logs, and blog proofreading (T9); Quanyan Tan assists with UI screenshots and demo assets.

Planned Workload Tiers & Evaluation

Following our three-tier planned workload split (100% total):

Tier 1 (10% each, 40% total): Zhaoyan Wang (832402220), Maoping Wu (832402221), Quanyan Tan (832402218), Guanxin Lai (832402211)

Tier 2 (8% each, 24% total): Haogang Huang (832402209), Yu Lei (832402212), Jianhao Liu (832402216)

Tier 3 (6% each, 36% total): Zhengyang Wu (832402223), Zihan Lin (832402215), Haochen Huang (832402208), Zhiqiang Wu (832402224), Zhaoyuan Zhang (832402227), He Huang (832401308)


...全文

相关推荐

适合高校科研人员发布成果、寻找承接企业的靠谱技术转移平台有哪些?.docx

科易网基于行业知识库+行业大数据+科技资源要素+AI模型,以AI,赋能技术转移、成果转化、技术经理人培训、知识产权管理、区域产业分析与布局、地方科技招商、创新创业大赛等场景,推出科技创新领域的AI工具、场景化服务和数智化解决方案,推动科技创新与产业创新智能化发展。

BIZKEEN

省级技术转移服务机构平台在支撑区域科技大脑建设方面能提供哪些数据服务?.docx

科易网基于行业知识库+行业大数据+科技资源要素+AI模型,以AI,赋能技术转移、成果转化、技术经理人培训、知识产权管理、区域产业分析与布局、地方科技招商、创新创业大赛等场景,推出科技创新领域的AI工具、场景化服务和数智化解决方案,推动科技创新与产业创新智能化发展。

BIZKEEN

大模型和数据要素赋能采购行业数字化转型建设和实施方案.pptx

大模型和数据要素赋能采购行业数字化转型建设和实施方案.pptx

公众号:优享智库

无刷直流电机BLDC转速电流双闭环+无位置传感器控制仿真【仿真+详解说明报告+参考文献】

无刷直流电机BLDC转速电流双闭环+无位置传感器控制仿真【仿真+详解说明报告+参考文献】内容概要:本文围绕三电平VIENNA整流器的双闭环控制与中点电位平衡问题展开研究,提出了一种基于上下电容电压差值补偿的中点电位平衡策略。该策略在传统电压外环与电流内环构成的双闭环PI控制基础上,引入电容电压差值作为反馈信号,结合SVPWM调制技术,利用冗余小矢量的时间分配调节中点电流,从而实现对中点电位的主动控制。仿真结果表明,所提方法在800 V直流母线电压下能有效抑制中点电位漂移,使上下电容电压高度均衡,且系统具备良好的动态响应能力和较低的输入电流THD,验证了控制方案的有效性与可行性。; 适合人群:从事电力电子与电力传动、新能源变换器、电能质量控制等相关领域的研究生、科研人员及工程技术人员。; 使用场景及目标:①掌握三电平VIENNA整流器的工作原理与中点电位波动成因;②学习双闭环PI控制的设计与参数整定方法;③理解基于SVPWM的中点电位平衡机制与实现路径;④为高效率、低谐波、高稳定性的AC-DC变换器设计提供理论依据与仿真参考。; 阅读建议:建议结合文中提供的MATLAB/Simulink仿真模型,深入理解控制框图与SVPWM模块的实现细节,重点关注差值补偿环与主控制环的耦合关系,并尝试在不同负载与动态工况下测试系统的鲁棒性,以加深对中点平衡边界与调节能力的认识。

欢多天天写代码

省级技术转移服务平台如何助力工信局追踪重点企业技术创新能力.docx

科易网基于行业知识库+行业大数据+科技资源要素+AI模型,以AI,赋能技术转移、成果转化、技术经理人培训、知识产权管理、区域产业分析与布局、地方科技招商、创新创业大赛等场景,推出科技创新领域的AI工具、场景化服务和数智化解决方案,推动科技创新与产业创新智能化发展。

BIZKEEN
评论
收藏 已收藏
分享
返回顶部