Skip to content

Contributing

이준혁 edited this page Jun 24, 2020 · 2 revisions

contributing with source codes

  1. Director에게 연락하여 firebase의 Awesome_ChattingApp의 접근 권한을 얻습니다.
  2. 작업 환경은 Android Studio 3.6.3, JAVA version 12로 설정합니다.
  3. 다음과 같은 명령어를 작성하여 Awesome_ChattingApp의 레포지토리에 있는 모든 소스코드를 다운 받고, 자신의 브랜치를 생성합니다. 이때, 브랜치 명은 자신의 Github 닉네임으로 작성합니다.
git clone [email protected]:bnbong/Awesome_ChattingApp.git

git branch [contributor's github nickname]

git checkout [contributor's github nickname]

git push --set-upstream origin [contributor's github nickname]
  1. 소스코드와 관련된 작업을 마친 뒤, 작업물을 본 레포지토리에 업로드하는 방법은 다음과 같습니다.
git status

git add .../newfile.java

git commit -m "write your works"

git push origin [contributor's github nickname]

주의사항

  • 본 프로젝트에서 요구하는 코딩스타일은 없으나, 자신의 소스코드의 클래스 앞에 이 클래스가 무엇을 위한 클래스인지 주석으로 한줄정도 요약해주시면 감사하겠습니다.
  • 버그 픽스등의 source code contributing은 별다른 허가 없이 수정하는 것이 가능합니다. 다만, 새로운 서비스를 추가할 때에는 무조건 디렉터에게 알린 후 허락을 맡고 작업하셔야 합니다.

contributing with documentation

  1. 다음과 같은 명령어를 작성하여 Awesome_ChattingApp의 레포지토리에 있는 모든 소스코드를 다운 받고, 자신의 브랜치를 생성합니다. 이때, 브랜치 명은 자신의 Github 닉네임으로 작성합니다.
git clone [email protected]:bnbong/Awesome_ChattingApp.git

git branch [contributor's github nickname]

git checkout [contributor's github nickname]

git push --set-upstream origin [contributor's github nickname]
  1. 문서화와 관련된 작업을 마친 뒤, 작업물을 본 레포지토리에 업로드하는 방법은 다음과 같습니다.
git status

git add .../newfile.md

git commit -m "write your works"

git push origin [contributor's github nickname]

주의사항

  • README.md파일은 절대수정하지 마세요!!!
  • 새로운 문서화 작업물은 모두 /docs 폴더에 저장해주세요

contributing with source codes

  1. Contact to Directorand gain permission of firebase's Awesome_ChattingApp accessment.
  2. Set the working environment to Android Studio 3.6.3, JAVA version 12.
  3. Use the following command to download all source codes from the Awesome_ChattingApp's repository and create your own branch. At this time, the Branch name is written with your Github nickname.
git clone [email protected]:bnbong/Awesome_ChattingApp.git

git branch [contributor's github nickname]

git checkout [contributor's github nickname]

git push --set-upstream origin [contributor's github nickname]
  1. Once you have finished working with the source code, the procedure for uploading your work to this repository is as follows:
git status

git add .../newfile.java

git commit -m "write your works"

git push origin [contributor's github nickname]

precautions

  • There is no coding style required by this project, but I would appreciate it if you could summarize a line of what this class is for in front of the class of your source code.
  • It is possible to modify the source code attribution of the bug fix without permission. However, when adding a new service, you must inform the director and get permission to work.

contributing with documentation

  1. Use the following command to download all source codes from the Awesome_ChattingApp's repository and create your own branch. At this time, the Branch name is written with your Github nickname.
git clone [email protected]:bnbong/Awesome_ChattingApp.git

git branch [contributor's github nickname]

git checkout [contributor's github nickname]

git push --set-upstream origin [contributor's github nickname]
  1. Once you have finished working on documentation, the procedure for uploading your work to this repository is as follows:
git status

git add .../newfile.md

git commit -m "write your works"

git push origin [contributor's github nickname]

precautions

  • Plese do not modify README.md file!!!
  • Please save all new documents in the /docs folder.