GitHub에서 회사 내부 문서를 관리하면 버전 관리가 쉽고 댓글에 따라 관계자의 변경을 볼 수 있어 편리하기 때문에 최근 회사 내 일부 파일을 GitHub로 옮겼다.
한편 며칠 전 쿡패드 개발자 블로그에 Markdown と GitHub で社内規程を便利に管理라는 글이 공개됐다.
https://techlife.cookpad.com/entry/2019/06/26/182322
우리뿐만 아니라 많은 곳에서 엔지니어가 비엔지니어에게 어떻게 탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁탁
편집기를 사용하지 않고 명령도 하지 않습니다.github.com에서 파일 편집에서 Pull Request 작성에 이르는 방법을 완료합니다.나는 가능한 한 비엔지니어에게도 무슨 일이 있으면 편집해 달라고 부탁할 생각이다.
* 여기에는 markdown이 없습니다.

초간단 Git/GitHub 용어 설명

GitHub의 UI에서 완성되는 장점 중 하나는 Git 지식이 거의 필요하지 않다는 것이다.
그래서 필요한 최소한의 설명에만 국한된다.웹 UI가 할 수 있는 일이 한정되어 있기 때문에 잘 이해할 필요가 없고 사용하는 과정에서 알게 될 것이다.

Pull Request

파일과 원본 코드의 변경을 제시합니다. "이렇게 변경하고 싶은데 어떻습니까?"

Reviewer

"이 변경 어때요?"

commit

변경(차이)의 요약

branch

다른 사람과 함께 일해도 괜찮을 수 있도록 자신이 쓰는 작업장으로 만든 것은 브랜치.이 요약을 제출하고 끌어당기기 요청으로 설정합니다.

세상에 상세하게 쓰여 있는 기사가 지저분하니 더 많은 사람을 알고 싶으면 저쪽을 참고하세요
추천은↓
https://qiita.com/yunico-jp/items/87bdd13971e82833f6bb

Pull Request 작성 및 댓글 요청

파일 작성 및 편집

새 파일을 만들 때:
기존 파일을 편집하려면 다음과 같이 하십시오.


화면 편집은 이런 느낌이에요.

참고로 파일 이름 / 을 구분해서 입력해서 새 폴더를 만들 수도 있습니다.

Pull Request 작성

편집 가능한 드래그 요청을 작성합니다.
텍스트 필드 아래의Commit Changes 양식에서 만들기

Commit 메시지 입력

입력하지 않으면 Update <変更したファイル名>

어떤 변경을 했는지 적으십시오 e.g.) Add FAQ part

선택 Create a new branch for this commit and start a pull request

branch명

이대로 가도 되지만 팀에 따라 규칙이 많다.<username>/<変更内容> 또는

Propose file change는 이러한 뷰입니다.

설명 중
- Why: 왜 변경합니까?
-What: 구체적으로 변경된 사항
쓰세요.이게 있으면'왜 여기가 이럴까'하는 교류를 줄일 수 있을 뿐만 아니라 리뷰어도 쉽게 리뷰를 할 수 있고 일찍 리뷰를 받을 확률도 높아진다.
효과적인 댓글 작성법은 다음과 같이 요약되어 있으니 꼭 보십시오.
https://qiita.com/umanoda/items/93aec41213f8e3ce14c8
제목과 설명을 완성한 후 클릭Create pull request.

"끌어당기기 요청" 에 여러 개의 제출 포함

이것은 창설된 당김 요청에서도 다른 변경에 협조하고 싶을 때의 방법이다.
먼저 Pull Request 뷰에서 현재 만든 Branch 링크를 클릭합니다.

자료 라이브러리의 맨 위로 뛰어오르는 것은 방금 만든 브랜치입니다.이 상태에서 파일을 만들고 편집합니다.

Commit Changes 양식에서 제출 메시지Commit directly to the takose-patch-1 branch.를 입력하고 Commit changes를 클릭합니다.

방금 master한 곳은 takose-patch-1입니다.이는'방금 한 takose-patch-1branch에commit을 추가한다'는 뜻이다.
지금 방금 만든 Pull Request를 확인해 보겠습니다.당김 요청을 찾으려면 맨 위에 있는 당김 요청 탭을 클릭하여 목록을 봅니다.

방금 작성한 Pull Request를 확인하고 추가로 제출했습니다.

개정 지정

사이드바에서 리뷰어를 지정한 후 리뷰어의 반응을 기다리고 필요에 따라 수정하는 등.

변경 사항 반영

Approve 반영 변경 사항을 검토자에게서 받으면 Merge pull request → Confirm merge 을 클릭하면 변경이 반영됩니다.

심사 방법

변경 확인

감사를 요청하면 먼저 변경 사항을 확인하십시오.
변경 사항을 보려면 파일changed 옵션 카드를 누르십시오

이런 느낌으로 점수를 표시합니다.

논평을 발표하다

Conversation 탭에서 일반 주석 외에 특정 행에 대한 주석도 사용할 수 있습니다.댓글이 원하는 줄의 왼쪽 끝에 멈추면 + 아이콘이 뜨고, 클릭하면 댓글이 뜨는 형식이다.

자세한 내용은 생략했지만 Add single comment 이렇게 댓글 하나를 뒤에 놓고, Start a review 여러 개의 댓글을 한데 모아 한 번에 뒤에 놓을 수 있다.기본적으로Add single comment를 사용하면 됩니다.

덧붙이다

모두 보고 화면 오른쪽 상단의 Review changes에서 Review 결과를 선택하십시오.
어느 것을 선택하는지는 엄격하게 규정된 규칙이 아니다. 대체로 다음과 같다.

이대로 변경을 반영할 수 있다면Approve

수정할 부분이 있으면 Request changes

판단할 수 없는질문이 있을 때Comment

Approve 이외의 경우에는 상대방의 반응과 수정을 기다리며 다시 Review를 진행하여 Approve가 나올 때까지 반복합니다.

Tips

차이 표시 레이아웃

기본적으로 차분 디스플레이의 레이아웃은 한 줄의 차분을 표시하지만, 개인적으로는 변경 전후를 좌우로 나누는 것을 권장합니다.기어 태그를 클릭하고 변경을 위해 SplitApply and reload을 선택합니다.

한 줄의 변경이라면 큰 변화는 없지만 이렇게 된다.

suggestion

Pull Request 주석에는 suggestion 기능이 있습니다.
텍스트 필드 위의 파일 아이콘을 누르면 다음과 같이 지정된 줄의 내용을 자동으로 작성합니다.이걸 편집하면...

이런 느낌은 수정을 제의할 수 있다.

심사를 받은 사람은Commitsuggestion에서 쉽게 포함시킬 수 있다.

마지막

GitHub으로 회사 내부 파일을 관리하면 행복해지겠죠.😜