github로 협업하는 방법 (git-flow)

해당 글은 팀원 입장에서 작성된 글이다.

 

팀장이 베이스가되는 깃허브 레포지토리를 생성하고 생성된 레포지토리를 어떻게 사용하는지를 글로 정리했다.

 

팀장님의 github 클론하기

git clone [깃허브 repo URL]

• git clone을 하면 원격 저장소 설정까지 불러오니 따로 원격 저장소를 지정할 필요는 없다.

 

원격 저장소 확인하는 방법

git remote -v 

---

로컬에서 새로운 브랜치 생성

git checkout -b [브랜치 명]

 

main 브랜치 기반 말고 특정 브랜치를 기반으로 생성하고 싶다면?

origin/dev 브랜치를 기반으로 새로운 브랜치 jueon 생성

git switch -c jueon origin/dev

 

 

새로운 브랜치를 원격 저장소에 푸시

git push origin [브랜치 명]

---

git pull

git pull origin dev

 

내 프로젝트가 sqlite를 사용할 때

잠깐! sqlite는 github에서 지원을 안한다.

만약 해당 프로젝트에서 sqlite를 사용한다면 아래 명령어를 먼저 사용하고 pull 명령어를 입력해야한다.

git rm --cached db.sqlite3

 

그리고 .gitignore 파일에 sqlite를 추가해야 한다.

db.sqlite3

 

---

git push

※ 반드시 작업 시작 전에 pull 해야 한다. 안그럼 충돌 생길 수도 있다.

변경된 파일을 스테이징

git add [파일명]

• 파일을 여러개 추가할 수도 있고 . 으로 전체 변경사항을 추가할 수 있다.

 

커밋 생성

git commit -m "커밋 내용"

 

 

팀 프로젝트에서 커밋 내용 남기는 방법?

보통 main <- dev <- feat 이 순서로 git을 병합한다.
main은 최종 배포할 프로젝트 코드가 올라가는 브랜치다.
dev는 개발 단계에서 배포 전 단계이다.
feat는 기능 하나 구현할 때 새로 브랜치를 파서 작업한다.
그럼 작업자는 주로 feat 브랜치에서 작업을 하게 될 텐데 브랜치명은 feat/번호/기능 이렇게 작성한다.
여기서 번호는 브랜치 생성 전에 어떤 기능을 작업할 건지 issue를 먼저 생성하고 여기서 생성된 번호를 가져온다.
커밋 메시지는 다음과 같이 남기면 된다.
"[feat/3/search] 검색 기능 구현"

 

 

원격 저장소에 푸시

git push origin <브랜치명>

 

.gitignore?

Git에서 특정 파일이나 디렉토리를 버전 관리에서 제외하기 위해 사용된다.

이 파일에 정의된 패턴에 일치하는 파일들은 Git이 추적하지 않으며, 커밋 대상에서 제외된다.

파일은 프로젝트 루트 폴더에 위치한다.

 

Django 프로젝트에서 .gitignore에 추가해야할 사항

migrations/*initial.py
__pycache__/
*.pyc
db.sqlite3      # db를 sqlite 사용한다면 추가

 

실제 Django 웹 프로젝트에서 사용한 .gitignore 파일

### JetBrains template
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
# Reference: <https://intellij-support.jetbrains.com/hc/en-us/articles/206544839>

migrations/*initial.py
db.sqlite3

.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf
.idea/**/aws.xml
.idea/**/contentModel.xml
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml
.idea/**/gradle.xml
.idea/**/libraries
.idea/**/mongoSettings.xml
.idea/replstate.xml
.idea/sonarlint/
.idea/httpRequests
.idea/caches/build_file_checksums.ser
.idea_modules/
*.iws
out/
atlassian-ide-plugin.xml
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Gradle and Maven
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr

# CMake
cmake-build-*/

### Python template
__pycache__/
*.pyc
*.py[cod]
*$py.class
*.so
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
*.manifest
*.spec
pip-log.txt
pip-delete-this-directory.txt
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
*.mo
*.pot
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
instance/
.webassets-cache
.scrapy
docs/_build/
.pybuilder/
target/
.ipynb_checkpoints
profile_default/
ipython_config.py
# .python-version
#Pipfile.lock
#poetry.lock
.pdm.toml
.pdm-python
.pdm-build/
__pypackages__/
celerybeat-schedule
celerybeat.pid
*.sage.py
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
.spyderproject
.spyproject
.ropeproject
/site
.mypy_cache/
.dmypy.json
dmypy.json
.pyre/
.pytype/
cython_debug/

# 환경 변수 및 보안
.env
.env.*
*.secret
*.pem
*.key

# 미디어 및 업로드 파일
media/
uploads/

# 마이그레이션 캐시
*/migrations/__pycache__/
*/migrations/*.pyc
*/migrations/*.pyo
**/migrations/0*

# VSCode 설정
.vscode/

# 운영체제별 캐시
.DS_Store
Thumbs.db
desktop.ini

# 백업 및 빌드 캐시
*.bak
*.swp
*.tmp

# Git 충돌/백업
*.orig