Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

πŸ“š Naming Convention #1

Closed
KSAhh opened this issue Nov 11, 2024 · 0 comments
Closed

πŸ“š Naming Convention #1

KSAhh opened this issue Nov 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
κ΅¬ν˜„ 및 μ΅œμ’… ν…ŒμŠ€νŠΈ

Comments

@KSAhh
Copy link
Owner

KSAhh commented Nov 11, 2024 •
edited
Loading

1. λ³€μˆ˜, ν•¨μˆ˜, 클래슀, 디렉토리 λ“±

ν™˜κ²½ μ‚¬μš©μ²˜ 넀이밍 λ£° μ˜ˆμ‹œ
JavaScript λ³€μˆ˜, ν•¨μˆ˜ camelCase userInfo
Python λ³€μˆ˜, ν•¨μˆ˜ kebab-case user-info
Python 클래슀 PascalCase UserInfoSerializer
Python μƒμˆ˜ λ³€μˆ˜ UPPER_CASE API_KEY
Vue Vue파일 PascalCase AddUserInfo.vue
Django 디렉토리 snake_case my_project

Boolean νƒ€μž… λ³€μˆ˜

  • 접두사 is μ‚¬μš©
  • ex) is_exist

클래슀

  • λͺ…μ‚¬μ ˆ μ‚¬μš©
  • ν…ŒμŠ€νŠΈ ν΄λž˜μŠ€λŠ” "Test"둜 끝날 것 / ex) WatcherTest

λ©”μ„œλ“œ

  • 동사/μ „μΉ˜μ‚¬λ‘œ μ‹œμž‘ν•  것
  • ex) renderHTML(), toString()

기타

  • μž„μ‹œ λ³€μˆ˜ μ™Έμ—λŠ” 1κΈ€μž 이상 μ‚¬μš©

2. 브랜치

master branch

  • μ œν’ˆ μΆœμ‹œ μˆ˜μ€€μ˜ 브랜치 / 배포 κ°€λŠ₯ν•œ μƒνƒœ
  • 배포 이λ ₯ 관리 용

develop branch

  • λ‹€μŒ μ„œλΉ„μŠ€ 개발 브랜치
  • 개발 브랜치 병합 용
  • 개발 μ™„λ£Œ ν›„, master둜 병합

feature branch

  • μƒˆλ‘œμš΄ κΈ°λŠ₯ 개발 / κΈ°λŠ₯ κ΄€λ ¨ 버그 μˆ˜μ • 용 (이슈번호 연동)
  • develop λΈŒλžœμΉ˜λ‘œλΆ€ν„° λΆ„κΈ°
  • font, back ꡬ뢄
  • ex) feature/front/login, feature/back/login, feature/front/#4-login
@KSAhh KSAhh converted this from a draft issue Nov 11, 2024
@KSAhh KSAhh added the documentation Improvements or additions to documentation label Nov 11, 2024
@KSAhh KSAhh moved this from Ready to In progress in web project - finance Nov 11, 2024
@KSAhh KSAhh pinned this issue Nov 11, 2024
@KSAhh KSAhh changed the title Naming Convention πŸ“š Naming Convention Nov 11, 2024
@KSAhh KSAhh closed this as completed Nov 29, 2024
@github-project-automation github-project-automation bot moved this from In progress to Done in web project - finance Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
web project - finance
Status: Done
Milestone
κ΅¬ν˜„ 및 μ΅œμ’… ν…ŒμŠ€νŠΈ
Development

No branches or pull requests
1 participant
@KSAhh