search

AutonomicMachineLearning / MLFramework

1 stars 1 forks source link

스타일 가이드 작성 #6

Open chatterboy opened 5 years ago

chatterboy commented 5 years ago

스타일 가이드 작성

  1. PEP8과 구글 코딩 스타일 기반으로 작성
  2. 웹 프로그래밍에 적합한 스타일을 위해 w3school을 참고
  3. 별개로 spring-framework CONTRIB.md 파일 참고해서 PR에서 필요한 것들을 식별

적용 페이지 링크

https://github.com/AutonomicMachineLearning/MLFramework/wiki/MLFramework-style-guide

이슈

  1. 멤버함수에서 return은 사용하지 않고 멤버변수만 갱신되는 경우에는 주석에 어떻게 적어야 할까?

참고

[1] http://google.github.io/styleguide/pyguide.html [2] https://www.python.org/dev/peps/pep-0008/ [3] https://www.w3schools.com/html/html5_syntax.asp [4] https://github.com/spring-projects/spring-framework/blob/master/CONTRIBUTING.md [5] https://github.com/Yooii-Studios/Clean-Code