Repository navigation
Contributing
Entry-Sync에 관심을 가지고 기여해주셔서 감사합니다!
버그 수정, 기능 추가, 문서 개선, 아이디어 제안 등 다양한 형태의 기여를 환영합니다.
Entry-Sync에 기여하는 일반적인 과정은 다음과 같습니다.
Issue / Discussion
↓
Fork Repository
↓
Create Branch
↓
Make Changes
↓
Test
↓
Commit
↓
Push
↓
Create Pull Request
큰 변경 사항이나 새로운 기능을 추가하기 전에 관련 내용을 먼저 이야기하는 것을 권장합니다.
Discussions를 이용해주세요.
다음과 같은 주제에 적합합니다.
- 새로운 기능 아이디어
- 사용 방법 질문
- 개발 관련 질문
- 프로젝트에 대한 의견
- 기능 개선에 대한 논의
버그는 Issues의 Bug Report를 이용해주세요.
새로운 기능이나 개선 사항은 Feature Request를 이용해주세요.
Entry-Sync Repository를 Fork합니다.
https://github.com/good-bad-code/Entry-Sync
Fork한 Repository에서 변경 사항을 작업한 후 Pull Request를 생성해주세요.
변경 사항에 맞는 별도의 Branch를 생성하는 것을 권장합니다.
git checkout -b feature/my-featuregit checkout -b fix/my-buggit checkout -b docs/update-documentationBranch 이름은 변경 목적을 쉽게 알 수 있도록 작성해주세요.
Entry-Sync를 개발하려면 다음 환경이 필요합니다.
- Git
- Google Chrome
- 코드 편집기
- GitHub 계정
개발 환경 설정에 대한 자세한 내용은 Development 문서를 참고해주세요.
주요 소스 코드는 extension/ 디렉터리에 있습니다.
Entry-Sync/
├── .github/
├── extension/
│ ├── manifest.json
│ ├── content.js
│ ├── inject.js
│ ├── popup.html
│ ├── popup.js
│ └── icons/
├── README.md
├── CONTRIBUTING.md
├── CODE_OF_CONDUCT.md
├── SECURITY.md
└── LICENSE
프로젝트 구조에 대한 자세한 내용은 Project Structure를 참고해주세요.
코드를 변경할 때 다음 사항을 지켜주세요.
- 기존 코드 스타일을 최대한 유지해주세요.
- 불필요한 변경은 포함하지 마세요.
- 하나의 변경 사항은 가능한 한 하나의 목적에 집중해주세요.
- 민감한 정보나 인증 정보를 코드에 포함하지 마세요.
- API Key, 토큰, 비밀번호 등을 커밋하지 마세요.
변경 사항을 Pull Request로 제출하기 전에 가능한 범위에서 직접 테스트해주세요.
chrome://extensions/
에서 개발자 모드를 활성화한 후 Entry-Sync Extension을 다시 로드하여 테스트합니다.
확인할 항목:
- 기존 기능이 정상적으로 작동하는가?
- 새 기능이 정상적으로 작동하는가?
- Console에 새로운 오류가 발생하지 않는가?
- 다른 기능에 영향을 주지 않는가?
커밋 메시지는 변경 내용을 이해하기 쉽게 작성해주세요.
예:
git add .
git commit -m "feat: add sync status indicator"권장 형식:
type: description
예:
feat: add sync status indicator
fix: resolve websocket connection issue
docs: update installation guide
refactor: simplify sync logic
style: improve popup layout
변경 사항을 완료했다면 Pull Request를 생성해주세요.
PR을 생성할 때 다음 내용을 포함해주세요.
- 변경 사항
- 변경 이유
- 관련 Issue
- 테스트 방법
- 스크린샷 또는 영상 (UI 변경 시)
- 주의 사항
Pull Request에는 자동으로
PULL_REQUEST_TEMPLATE.md가 적용됩니다.
관련 Issue가 있다면 Pull Request에서 연결해주세요.
예:
Closes #12GitHub가 Pull Request가 Merge될 때 해당 Issue를 자동으로 닫을 수 있습니다.
Popup이나 Extension UI를 변경했다면 가능하면 Pull Request에 변경 전/후 스크린샷을 첨부해주세요.
예:
Before
[스크린샷]
After
[스크린샷]
보안 취약점은 공개 Issue나 Discussion에 작성하지 마세요.
보안 취약점은 Security Policy를 확인해주세요.
Entry-Sync의 모든 참여자는 CODE_OF_CONDUCT.md를 따라주세요.
서로 존중하는 커뮤니티를 만들어주세요.
Entry-Sync에 관심을 가지고 기여해주셔서 감사합니다.
작은 버그 수정부터 문서 개선, 새로운 기능까지 모든 기여가 프로젝트를 발전시키는 데 도움이 됩니다.
Happy Coding! 🚀