기여하기

reactive-kit은 누구나 쉽게 기여할 수 있도록 설계되었어요. 기여를 원하는 분들은 아래 가이드를 참고해 주세요.

구현체 기여

구현체를 기여할 때는 구현체의 유형에 따라 components, hooks, utils 디렉터리에 추가해 주세요. 모든 구현체는 아래 요소를 반드시 포함해야 해요.

• 구현체
• 가이드 문서
• 테스트 코드
• JSDoc

구현체 작성

reactive-kit의 설계 원칙을 따라야 해요. 특정 라이브러리에 의존하거나 React 생명 주기와 밀접하게 관련된 구현체는 제공하지 않아요. 설계 원칙을 준수해 구현체를 작성해 주세요.

가이드 문서 작성

모든 구현체는 가이드 문서를 포함해야 해요. 구현체와 동일한 이름으로 문서를 작성하면, 문서 목록에 자동으로 추가돼요. 문서는 사용법을 쉽게 이해할 수 있도록 상세히 작성해 주세요.

테스트 코드 작성

모든 구현체에는 테스트 코드가 반드시 포함되어야 하며, 구현체와 동일한 이름으로 작성해야 해요. 테스트 커버리지는 항상 100%를 만족해야 해요. 아래 명령어로 테스트 커버리지를 확인할 수 있어요.

yarn test:coverage

JSDoc 작성

모든 구현체는 JSDoc 주석을 포함해야 해요. JSDoc Block tags를 자유롭게 사용할 수 있지만, 아래 두 가지 태그는 필수예요.

• @description: 구현체의 기능이나 역할을 명확히 설명해요.
• @example: 구현체의 사용 방법을 예시 코드로 작성해요.

배포

main 브랜치에 병합되면 자동으로 배포가 진행돼요. 배포 결과는 GitHub Actions에서 확인할 수 있어요.

문서 기여

문서 기여 시 별도의 조건은 없어요. 잘못된 내용이 있거나 추가할 내용이 있다면 자유롭게 수정해 주세요. 문서는 독자가 쉽게 이해할 수 있도록 명확하고 간결하게 작성해 주세요.