Skip to content

[DOCS] CONTRIBUTING.md 작성 #235

@froggy1014

Description

@froggy1014

개요

.github/CONTRIBUTING.md를 변경된 컨벤션에 맞춰 업데이트합니다.

현재 상태

  • 브랜치 카테고리 테이블에 feat, hotfix, release, ci, build가 있으나 Slack 컨벤션과 불일치
  • 사용자명 포함 네이밍 규칙 미안내
  • 커밋 타입에 style, perf, revert 등 누락

변경 사항

1. 브랜치 카테고리 테이블 업데이트

Category Description
feature Developing a new feature
fix Fixing a bug
docs Documentation updates or additions
style Code style changes (formatting, no logic change)
refactor Code refactoring without functional changes
test Writing or modifying test cases
deploy Deployment-related changes
chore Maintenance tasks or minor updates
settings Configuration or settings changes

2. 브랜치 네이밍 형식 업데이트

  • 형식: <CATEGORY>/<SUBJECT>-<USERNAME>
  • USERNAME 포함 필수 (최소 1개 하이픈)
  • 예시: feature/button-jeongmin, fix/233-login-bug-jeongmin

3. 커밋 타입 안내 업데이트

conventional commits 표준 11개 타입으로 정리:
build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions