종합 설계 프로젝트 초기세팅

organization을 생성하여 server와 docs 레포지토리을 만들었다.

 

개인 레포지토리로 프로젝트를 운영할 수 있지만 issue, pullrequest 기능을 적극적으로 사용하고싶어 organization을 운영하기로 마음 었다.

 

먼저 레포지토리에 이슈와 커밋 템플릿, 풀리퀘스트를 적용했다.

그리고 readme 파일에 간단한 프로젝트 관련 정보를 적었다.

 

방법

1. 이슈 템플릿 적용

- setting>general>Features>set up templates

- add templates 에서 원하는 유형 선택

- preview and edit로 작성을 시작한다.

- 마크다운 문법을 활용하여 템플릿을 작성한다.

 

2. 커밋 템플릿과 풀리퀘스트 템플릿 적용

해당 예시에선 fullrequest와 merge하는 과정을 설명하기위해 직접 fork하여 예시를 보이겠다.

하기전 issue를 생성한다.

 

본격적으로 full request를 위해 fork한다.

 

그 후의 로직들

git clone https://github.com/dyd131001/project-docs.git
cd project-docs
git remote add knu https://github.com/knu-project/project-docs.git
git branch init/add_templetes
git switch init/add_templetes
# commit 템플릿 작성
vi .gitmessage.txt
git config --system commit.template .gitmessage.txt
cd .github
vi PULL_REQUEST_TEMPLATE.md
cd ..
vi .gitignore
git add .
git commit
git push origin init/add_templetes
# 오류 발생
git config --list
# remote 주소 확인
git remote set-url https://github.com/dyd131001/project-docs.git
git push origin init/add_templetes
# 토큰 생성 후 복붙
# 성공
# fullrequest 요청 후 병합 완료
git pull knu
git switch develop
git branch -D init/add_templetes

 

commit은 해당 내용으로 작성했다.

 

그리고 푸쉬하려고 했는데 계속 403 에러가 발생했다.

 

위의 remote 경로를 바꾼 후 토큰을 생성하여 해결했다.

 

해당 브랜치에 잘 push된걸 볼 수 있다.

 

gitignore에 .DS_Store를 기입하지않아 .DS_Store이 생겨 이걸 삭제해야했다.

 

git rm .DS_Store
vi .gitignore
git commit -m "delete: DS_Store"
git push origin init/add_templetes

 

잘 수정됐고 위의 Compare & pull request를 클릭하여 pull request 한다

base repository와 base를 잘 선택해야하는데 초기세팅이 main에 모두 적용되길 원해 develop 이 아닌 main으로 base를 설정하고 pull request를 보냈다.

 

 

이후 readme 파일을 수정해야한다는 걸 생각하고 고친다.

 

readme 파일을 다음과 같이 수정

 

그런데 github에 빈폴더같은 경우 올라가지 않다는 것을 확인했다.

일단 readme 파일을 commit한다.

 

# 빈폴더 마다 gitkeep 추가
cd tech-manual
touch .gitkeep

# init/add_templetes의 readme를 수정해서 버전을 맞춰야한다.
git pull origin init/add_templetes
git add .
 git commit -m "feat: add docs"
 git push origin init/add_templetes

 

잘 추가된것을 확인할 수 있다.

 

이제 organization에서 full request를 확인 후 병합한다.

 

fullrequest와 issue가 닫히고 성공적으로

main에 병합된걸 볼 수 있다.

 

organization 에 develop 브랜치를 만들기위해 원본 저장소를 clone하고 다음과 같은명령어를 수행했다.

git branch develop

git checkout develop

git push origin develop

 

최종적으로 fork한 레포지토리의 작업 브랜치를 삭제하면 된다.