Update CONTRIBUTING.md

This commit is contained in:
Kijin Sung 2017-07-22 20:32:04 +09:00
parent c15ddc5d5c
commit f953a53c09

View file

@ -22,6 +22,8 @@
- 브라우저의 개발자도구(F12)에 에러가 표시되는 경우, 콘솔 및 네트워크 탭의 스크린샷
- 증상을 확인해 볼 수 있는 웹사이트 주소
- 내부망이나 로컬 개발환경 등 외부인의 접속이 원천적으로 불가능한 경우가 아니라면 반드시 주소를 남겨 주시기 바랍니다.
- 공개적인 개발을 추구하는 오픈소스 소프트웨어의 특성상, 이슈 해결에 필요한 정보를 공개하지 않는 경우
처리가 지연되거나 제3자에게 비용을 지불하고 해결해야 하는 등 불이익이 발생할 수 있습니다.
## 풀 리퀘스트(PR) 작성
@ -186,7 +188,7 @@ PHPDoc 주석 작성에 어려움이 있는 경우, 다른 클래스와 함수
### 커밋 메시지
커밋 메시지는 가능하면 영문으로 작성하며, **현재형** 동사로 시작하는 **명령형** 문장 사용을 원칙으로 합니다.
커밋 메시지는 가능하면 영문으로 작성하며, **동사원형**으로 시작하는 **현재형**, **명령형** 문장 사용을 원칙으로 합니다.
Delete unnecessary condition // RIGHT
Fix #1234 // RIGHT
@ -204,10 +206,12 @@ PHPDoc 주석 작성에 어려움이 있는 경우, 다른 클래스와 함수
### 기타
Rhymix의 기본 `error_reporting` 설정 하에서 어떤 에러도 발생하지 않도록 하는 것을 목표로 합니다.
Rhymix의 기본 `error_reporting` 설정 하에서 어떤 에러도 발생하지 않도록 하는 것을 목표로 하지만,
선언하지 않은 변수 등 `E_NOTICE`를 일으키는 문제도 가능하면 새로 만들어내지는 않도록 합니다.
문자열과 문자열, 정수와 정수를 비교할 때는 가능하면 `==` 대신 `===`을 사용합니다.
실제 자료형이 다를 가능성이 있는 경우 `intval()`, `strval()` 등의 함수와 함께 사용합니다.
정수는 항상 64비트 범위를 가지는 것으로 가정합니다.
PHP 5.4 이상에서 지원하는 간단한 배열 문법(`[1, 2, 3]`)을 사용할 수 있으나,
복잡한 구조의 배열을 선언할 때는 이 문법이 오히려 가독성을 해칠 수 있으니 주의하시기 바랍니다.
@ -217,3 +221,10 @@ PHP 5.4 이상에서 지원하는 간단한 배열 문법(`[1, 2, 3]`)을 사용
여기에서 규정하지 않은 내용은 [PSR-1](http://www.php-fig.org/psr/psr-1/)과
[PSR-2](http://www.php-fig.org/psr/psr-2/)를 따릅니다.
composer 라이브러리를 업데이트할 때는 라이믹스에서 공식적으로 지원하는 환경(PHP 5.5.9 이상)에서
정상 작동하는 버전으로 고정시켜야 합니다. PHP 5.6 또는 7.x를 필요로 하는 라이브러리를 가져와서는 안됩니다.
또한 불필요한 라이브러리가 들어오는 것을 막기 위해 반드시 아래의 명령으로 업데이트합니다.
composer update --no-dev --optimize-autoloader