CONTRIBUTING.md

hacklms 기여 가이드

hacklms 프로젝트에 관심을 가져주셔서 감사합니다.

이 프로젝트는 숭실대학교 LMS를 위한 유틸리티를 제공하는 크롬 확장 프로그램입니다. 버그 수정 및 제보, 기능 개선, 문서 보완, 코드 정리, UX 개선 등 다양한 형태의 기여를 환영합니다.

개발 환경 설정

1. 원본 저장소를 포크합니다.
2. 포크한 저장소를 로컬에 클론합니다.
3. 브랜치를 생성합니다.

git clone https://github.com/<your-username>/hacklms.git
cd hacklms
git checkout -b feature/my-improvement

Chrome 브라우저에 확장 프로그램 설치

Chrome 확장 프로그램을 실제 브라우저에서 확인하려면 다음 절차를 따라 주세요.

1. Chrome 브라우저에서 chrome://extensions로 이동합니다.
2. 우측 상단의 "개발자 모드"를 활성화합니다.
3. "압축 해제된 확장 프로그램 로드" 버튼을 클릭합니다.
4. 프로젝트 루트 폴더를 선택합니다. (루트 디렉터리에 manifest.json 파일이 있어야 합니다.)
5. 확장 프로그램이 설치되면 브라우저에 아이콘이 표시됩니다.

확장 프로그램을 수정한 뒤에는 브라우저에서 다시 로드하거나 새로고침을 통해 변경 사항을 반영할 수 있습니다.

디버깅 방법

• 팝업 디버깅: 확장 프로그램 아이콘을 클릭한 뒤 우클릭 후 "검사"
• 백그라운드 스크립트 디버깅: chrome://extensions에서 해당 확장 프로그램 선택 후 "검사"
• 콘텐츠 스크립트 디버깅: LMS 페이지에서 F12를 눌러 DevTools 열기
• console.log() 또는 브레이크포인트를 사용해 로직 흐름을 추적합니다.
• 변경 후에는 chrome://extensions에서 확장 프로그램을 다시 로드하거나 브라우저를 새로고침해 확인합니다.

코딩 스타일

• 불필요한 의존성 추가를 지양합니다.
• 기존 프로젝트 스타일과 일관성을 유지합니다.
• 불필요한 주석은 피하고, 의도가 불분명한 부분만 주석으로 설명합니다.
• 사용하지 않는 변수나 코드는 제거합니다.

로컬 테스트 및 검증

변경 사항을 반영한 뒤에는 실제 Chrome 브라우저에서 아래를 확인해 주세요.

• 확장 프로그램이 정상적으로 로드되는지
• 기능이 기대대로 동작하는지
• 콘솔에 오류가 없는지
• 기존 기능이 깨지지 않았는지

Pull Request 가이드

• PR을 생성하기 전 현재 브랜치가 메인 브랜치와 충돌하지 않는지 확인합니다.
• PR 제목은 변경 내용을 한 문장으로 간단히 요약합니다.
• 내용에는 변경 이유와 확인한 동작을 함께 적습니다.
• 관련 이슈가 있다면 함께 연결합니다.

PR 제목 예시:

• 강의 세션 파싱 오류 수정
• 강의 목록 렌더링 성능 개선
• 기여 가이드 문서 추가

문서화

코드 변경이 있거나 동작 방식이 바뀐 경우, 관련 문서도 함께 업데이트해 주세요.

버그 제보

버그를 제보할 때는 다음 정보를 포함해주세요.

• 명확한 제목
• 문제 설명
• 재현 단계
• 기대 동작
• 실제 동작
• 브라우저/환경 정보
• 가능하면 스크린샷 또는 로그

이 정보가 있으면 문제를 빠르게 확인하고 수정할 수 있습니다.

기능 제안

기능 제안은 언제나 환영입니다. 제안 시 해결하는 문제와 사용자 입장에서 기대되는 동작을 포함해 주세요.

모든 제안이 수용되는 것은 아니지만, 아이디어와 피드백은 항상 가치 있습니다.

질문이 있으신가요?

기여 전에 궁금한 점이 있다면 저장소의 이슈를 통해 문의해 주세요. 적극적이고 건설적인 기여를 환영합니다.

hacklms 프로젝트가 더 나은 방향으로 발전할 수 있도록 함께 해주셔서 감사합니다.