민양테크 표준 기여방침

1. 기본 원칙

본 프로젝트는 오픈소스 프로젝트이며, 누구나 Issue 또는 Pull Request를 통해 개선에 참여할 수 있습니다.

이 문서는 민양테크가 공개하는 오픈소스 프로젝트에 공통으로 적용됩니다. 프로젝트별 README, LICENSE, SECURITY, 별도 CONTRIBUTING 문서가 있는 경우 해당 문서가 우선 적용될 수 있습니다.

2. Merge가 거부될 수 있는 항목

• 악성 코드, 백도어, 사용자 동의 없는 정보 수집 코드
• 의도적으로 읽기 어렵게 만든 난독화 코드
• 프로젝트 방향성과 무관하거나 범위가 과도하게 넓은 기능
• 필요성이 충분히 설명되지 않은 과도한 의존성 추가
• 라이선스 충돌 가능성이 있거나 출처가 불명확한 코드 또는 에셋
• 보안 설정을 우회하거나 사용자 안전을 약화시키는 변경
• 기존 기능을 중단시키면서 마이그레이션 또는 설명이 없는 변경
• 테스트, 문서, 사용 방법이 없는 대규모 기능 추가

3. 기여 방법

개발 환경은 프로젝트마다 다를 수 있으나, Node.js 기반 프로젝트는 일반적으로 아래 흐름을 따릅니다.

npm install
npm run dev

1. 저장소를 Fork합니다.
2. 작업 목적이 드러나는 브랜치를 생성합니다.
3. 변경사항을 적용하고 필요한 경우 테스트와 문서를 함께 수정합니다.
4. 의미 있는 단위로 Commit합니다.
5. Pull Request를 생성하고 변경 이유, 영향 범위, 확인한 내용을 작성합니다.

4. 권장 사항

• 큰 기능 추가 전에는 Issue를 먼저 생성해 방향을 논의해 주세요.
• 가능한 기존 코드 스타일과 파일 구조를 유지해 주세요.
• 불필요한 라이브러리 추가는 지양해 주세요.
• 실험적 기능은 목적, 사용 방법, 되돌릴 방법을 함께 설명해 주세요.
• UI 변경은 가능하면 스크린샷 또는 짧은 설명을 포함해 주세요.
• 보안, 네트워크, 파일 시스템, 실행 권한과 관련된 변경은 위험 요소를 명확히 적어 주세요.

5. 기여 가능 분야

• 새 기능 또는 새 노드 추가
• UI/UX 개선
• 버그 수정
• 성능 최적화
• 접근성 개선
• 문서화 및 예제 보강
• 테스트, 빌드, 배포 자동화 개선
• 오타, 번역, 링크 오류 수정

6. 문서 기여

민양테크 공식 문서 사이트에 기여하고 싶다면 민양테크 웹사이트 저장소에 Pull Request를 보내 주세요.

문서 위치는 프로젝트에 따라 다르지만, 일반적으로 docs/ 하위 문서를 수정하면 됩니다.

공식 문서 페이지: https://minyangtech.n-e.kr/docs/index

7. 라이선스와 출처

기여자는 자신이 제출하는 코드, 문서, 이미지, 사운드 등 모든 자료를 해당 프로젝트 라이선스에 맞게 제공할 권리가 있어야 합니다.

외부 자료를 포함하는 경우 출처와 라이선스를 Pull Request에 명확히 남겨 주세요.

8. 참고

현재 일부 프로젝트는 구조 리팩토링이 진행 중일 수 있으며, 파일 구조가 완전히 정리되지 않았을 수 있습니다.

정리되지 않은 부분을 발견했다면 작은 단위의 개선 Pull Request도 환영합니다.

9. 문의

기여와 관련된 문의는 Issue 또는 아래 메일로 남겨 주세요.

support@minyangtech.n-e.kr