19 lines
2.2 KiB
Plaintext
19 lines
2.2 KiB
Plaintext
# Kord IDE Rules
|
|
|
|
## Documentation Rules
|
|
- 프로젝트와 관련된 진행/완료 내역(Work done), 기술/기획적 결정(Decisions made), 트러블슈팅(Troubleshooting) 내역은 `<PROJECT_ROOT>/Docs/` 디렉토리에 카테고리별로 작성합니다.
|
|
- 새로운 문서를 추가하거나 수정하면 반드시 `Docs/index.md`에 색인(링크)을 추가합니다.
|
|
- **모든 코드 수정, 버그 수정, 기능 추가 작업이 완료되면, 사용자의 명시적인 요청이 없더라도 작업 내역을 자동으로 `Docs/` 디렉토리에 문서화하고 색인(`index.md`)을 업데이트한 뒤에 작업 완료를 보고해야 합니다.**
|
|
- 문서에는 `체인지로그(Changelog)`와 `본문(Body)` 구조를 포함합니다.
|
|
- 다른 문서에 있는 내용을 중복해서 적거나 허위 사실, "향후 추가 예정" 같은 Placeholder를 작성하지 마십시오.
|
|
|
|
## Security Rules
|
|
- 비밀번호, API 키, 인증 토큰, URL에 포함된 인증 정보 등 민감한 정보는 소스 코드나 마크다운 문서 등 공개된 곳에 절대 기재하지 마십시오.
|
|
- 보안 설정값은 `.env` 등 Git 추적에서 제외된 파일을 사용하고 동적으로 로드하여 사용해야 합니다.
|
|
|
|
## Development & Testing Rules
|
|
- 기능을 구현하거나 수정한 후에는 사용자의 별도 지시나 알림이 없더라도 **반드시 스스로 `yarn build` 및 `yarn test`를 수행하여 코드의 정합성을 검증**해야 합니다.
|
|
- 유저에게 노출되는 모든 기능(메시지, 임베드, 상태 메시지 등)을 구성할 때는 별도의 요청이 없더라도 **반드시 다국어 지원(i18n) 적용을 검토하고 구현**해야 합니다. (자세한 내용은 `Docs/Rules/i18n_guidelines.md` 참조)
|
|
- 단순 문법 검증에 그치지 말고, `yarn dev` 등의 명령어로 봇을 백그라운드에서 직접 구동(Boot)시켜 DB/캐시 커넥트 및 이벤트 리스너 초기화 중 런타임 에러(예: Intents 권한 거부 등)가 발생하지 않는지 스스로 눈으로 확인하고 완벽히 디버깅해야 합니다.
|
|
- 봇이 성공적으로 온라인 상태(`Ready`)에 진입한 것을 확인한 뒤에만 사용자에게 작업 완료를 보고합니다.
|