📖 'Docs'페이지는?
개발을 하면서 느낀 어려움을 다시는 겪지말고자 다른 분들도 겪지 않았으면 하는 마음에 만든 지식 저장소입니다. 공식문서를 찾아보려해도 영어에 너무나 많은 방대한 양으로 내가 원하는 정보를 찾기 힘들어 더 쉬운 설명과 더 깊은 예제 까지 하나씩 설명해주는 포스트형 페이지입니다. 모든 문서는 GitHub를 통해 관리됩니다. 이는 여러분이 작성해주시는 모든 글은 단순한 지식 공유를 넘어, 오픈 소스 프로젝트에 기여하는 값진 경험을 가지며 다른 이에게 밝은 등불이 되어줄 것입니다.
🤝 Docs에 기여하는 방법
이 프로젝트는 여러분의 참여로 성장합니다. 아래 절차를 따라 Docs에 새로운 글을 추가하거나 기존 글을 수정할 수 있습니다.
1. 레포지토리 포크(Fork)하기
devsplatform-docs
레포지토리 페이지로 이동합니다.- 우측 상단의
Fork
버튼을 눌러 여러분의 개인 GitHub 계정으로 이 레포지토리를 복사합니다.
2. 글 작성 및 수정
- 포크한 레포지토리를 로컬 컴퓨터에 복제(Clone)하고 새로운 브랜치를 생성합니다.
git clone https://github.com/[여러분의-아이디]/devsplatform-docs.git
git checkout -b feature/새-문서-추가
또는git checkout -b fix/오타-수정
- 마크다운(.md) 형식으로 새로운 문서를 작성하거나 기존 문서를 수정합니다.
- 변경 사항을 커밋하고 푸시합니다.
git add .
git commit -m "feat: [주제] 관련 문서 초안 작성"
git push origin feature/새-문서-추가
3. Pull Request(PR) 보내기
- 여러분의 GitHub 페이지로 돌아가면, 방금 푸시한 브랜치에 대한 메시지가 보입니다.
Compare & pull request
버튼을 눌러 원본 레포지토리로 병합 요청을 보냅니다.- 관리자가 내용을 검토하고 병합하면, 여러분의 글이 플랫폼에 정식으로 게시됩니다.
여러분의 기여를 기다립니다!