Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
131 lines (78 loc) · 4.56 KB

CONTRIBUTING.md

File metadata and controls

131 lines (78 loc) · 4.56 KB

Contributing to OSSW_githubushim

Trippick "떠나자, 나답게"

트립픽은 여러분의 기여를 환영합니다.

📣 목차

  1. 시작하기에 앞서
  2. New Contributor Guide
  3. 기여 방법
  4. 이슈(버그 정보/기능 제안)
  5. 기여 시 유의사항
  6. 우선적으로 기여가 필요한 항목

📝 시작하기에 앞서

New Contributor Guide

✍️ 기여 방법

1. 레포지토리 포크(Fork) & 클론(Clone)

2. 새 기능/이슈용 브랜치 생성

  • git checkout -b feat/추천로직-개선
  • 또는
  • git checkout -b fix/주소파싱-오류

3. 코드 작성 및 커밋

  • Python 스타일 가이드는 PEP8을 준수해주세요.

  • 커밋 메시지는 다음과 같이 간결하고 명확하게 작성해주세요:

  • feat: 도시 추천 점수 계산 방식 변경 (코사인 유사도 도입)

  • fix: 태그 부여 중 null 데이터 처리 오류 해결

  • docs: README 내 실행 예시 업데이트

4. 테스트 및 문서화

  • 변경 사항이 기존 로직을 깨지 않도록 직접 실행 테스트를 해주세요.
  • 새로운 기능을 추가한 경우, 주석 또는 README/Docstring을 업데이트해주세요.

5. PR(Pull Request) 생성

  • main이 아닌 dev 브랜치로 PR을 보내주세요.
  • PR 템플릿을 따라 변경 사항, 이유, 테스트 결과 등을 명확히 작성해주세요.

6. 이슈 생성

  • 이슈 탭에서 논의해 주세요.

7. 웹사이트 디자인 준수

-trippick 디자인과 트립이(마스코트)를 지켜주세요. image

🐛 이슈(버그 제보 / 기능 제안)

문제를 발견하거나 새로운 기능을 제안하고 싶다면, 아래 템플릿을 참고해 이슈를 열어주세요.

name: 🐞 버그 리포트 about: 프로젝트에서 발견한 문제를 알려주세요. title: '[버그] 요약을 간단히 적어주세요' labels: ['bug'] assignees: []

설명 문제가 무엇인가요? (간단히 요약)

재현 방법

  1. 어떤 동작을 했나요?
  2. 어떤 입력을 주었나요?
  3. 어떤 결과를 기대했나요?
  4. 실제로 어떤 결과가 나왔나요?

환경 정보

  • OS: (e.g. Windows 10, macOS 11.2)
  • Node/Python 버전: (e.g. Node 14.17.0)
  • 브라우저: (웹인 경우)

스크린샷 / 에러 로그

📌 기여 시 유의사항

민감한 API Key는 .env 파일 또는 시크릿 설정을 따로 사용하며 절대 커밋하지 마세요.

tagged_contents.json, user_profile.json 등의 출력 파일은 .gitignore 처리되어야 합니다.

대규모 기능 추가 전에는 반드시 Issue를 생성하고 팀과 사전 논의해주세요.

🧪 우선적으로 기여가 필요한 항목

  • 콘텐츠 태그 분류 정확도 향상

  • 콘텐츠 필터링 시 filter_tags 적용 개선

  • Flask API를 통한 전체 추천 시스템 통합

  • 테스트 자동화 및 API 문서화(OpenAPI)

  • 챗봇 db 생성 및 추가 추천 로직(이전 출력값 제외)

🙏 감사의 말 기여는 단순한 코드 커밋뿐만 아니라, 문서 수정, 피드백 제공, 이슈 리포팅 모두 환영합니다. Trippick은 모두의 참여로 더 똑똑한 여행 추천 시스템이 됩니다! 🌏