Skip to content

issue #67 #79

Description

@zyntromedia

Here are the recommended Git commands, branch naming conventions, commit messages, and a structured pull request description for working on Issue #67 of ZyntroAI/fastapi-python-boilerplate.
(Note: Since GitHub returned an authentication wall for direct scraping of issue #67 without session cookies, the templates below are structured using standard conventions for the boilerplate repository. You can adjust the placeholder text [brief-issue-summary] or component names to precisely match the issue details).

  1. Create and Switch to a New Branch
    Choose a branch name that follows standard Conventional Commits or feature-branch patterns (feature/, fix/, or chore/ followed by the issue number):

Update your local main/development branch first

git checkout main
git pull origin main

Create and switch to the new issue branch

git checkout -b feature/issue-67-[brief-description]

Example: git checkout -b feature/issue-67-update-auth-middleware

  1. Suggested Commit Messages
    Make atomic, descriptive commits following the Conventional Commits specification (type(scope): description):
  • For initial implementation / feature additions:
    git commit -m "feat(api): implement feature/fix for issue CrystalCastle #67"

  • For adding or updating tests:
    git commit -m "test(core): add unit tests for issue CrystalCastle #67 changes"

  • For documentation updates:
    git commit -m "docs: update endpoint documentation for issue CrystalCastle #67"

  1. Pull Request Details
    Pull Request Title
    feat: resolve issue CrystalCastle #67 - [Insert Issue Title/Summary Here]

Pull Request Description Template

Description

This pull request addresses Issue #67 by implementing the requested changes, improving robustness, and ensuring compatibility with the existing FastAPI architecture, SQLModel configurations, and automated test pipelines.

Summary of Changes:

  • Core Logic: [Describe what code/endpoints/models were added or modified]
  • Testing: [Mention any new test cases added to tests/ and test coverage verification]
  • Dependencies/Config: [Note any environment, Pydantic, or configuration adjustments if applicable]

Related Issue


Checklist & Verification

  • Code follows the repository's style and linting guidelines.
  • Added/updated unit tests to cover the changes.
  • Verified local tests pass successfully (pytest).
  • Checked GitHub Actions workflow compatibility.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

dependenciesการอัปเดตหรือจัดการ dependency ของโปรเจกต์

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions