[Wanted]最初のプロジェクトコメント


Wecode x Wanted Free on Boddingの最初のプロジェクトをして、他の多くの人の良い事例を見ることができて、多くのことを学んで、本当に感謝しています.README、会議、提出情報等を記録し、今後積極的に利用したい箇所を記録する

1. README.mdの作成


READMDファイルはプロジェクトの顔です.第一印象に残る部分なのでなるべく簡潔で読みやすいように書きます第一印象に好感を持っている人に前向きな期待を寄せるように、上手に書いているREADMEには「あ、ここのコードが上手に書けたらいいな」という前向きな期待が生まれています.ただ楽で面倒なことだと思っているだけですが、今回の機会はしっかり押さえておきましょう.

READMEに含まれる内容

  • 課題(プロジェクト)関連企業情報
  • チームメンバー:名前と機能、ハブアドレスを書きます.表
  • 課題(項目)内容
  • 技術スタックおよびデータベース
  • を使用する
  • 必須実装(含む)機能
  • 開発要求
  • 使用技術と連携ツール
  • ERDモデリング画像ファイル
  • APIリスト:Postmanを使用して
  • に記入
  • 実施機能及び機能詳細説明
  • プロジェクトフォルダ構造
  • Reference
  • 注意:POSTMANを使用してAPIリストに記入する

    2.可読性の良いコード例


  • import文Python build-inモジュール、djangoモジュール、customモジュール
  • を区別する
  • のインデントに合わせます.=を例にして、最も長い単語を学んで+1格をプラスして最も良いです
  • が値を返すエラーメッセージは、messageを小文字または大文字に統一します.

    3. Unittest


    ユニットテストは、正常に実行されるだけでなく、失敗したさまざまな状況を実行します.

    4. Commit Message


    これは未来の私と周りの同僚たちのために書いたもので、いつ見ても誰でも理解できるようになっています.
  • Add: User app 생성 및 회원가입 엔드포인트 추가
    - 유저 앱을 만들고, 유저 모델 클래스 생성
    - 회원가입 엔드포인트 구현
    
    Remove: data csv 파일 삭제
    - 크롤링 결과 저장한 csv이 git에 잘못 올라와 해당 파일 삭제
    
    Fix: 상품 정보 입력시 필수 정보인 상품 사진 url 예외처리
    - 필수 입력 값인 image url이 body에 담겨있지 않을 때 key error 오류 처리
    - Return되는 오류 메시지 수정 (500 error -> 400 key error with 'image_url')
    
    로그인 기능이 문제가 있어서 수정함 (x)
    로그인 시도시 API 호출이 제대로 일어나지 않아 로그인이 되지 않는 버그 수정 (o)
    
    매장 데이터 검색 만듦(x)
    매장 위치 조회시 매장 위치의 위도/경도를 기준으로 필터링하는 기능 구현(o)
    

    注意:コミットメッセージの記入方法

    5.Load Test(学習中)


    今回同じレッスンを受講された方の使用例
  • https://github.com/godtaehee/Aimmo#%EC%9D%BC%EB%B0%98%EC%A0%81%EC%9D%B8-mongodb%EC%9D%98-typeorm%EC%9D%84-%EC%82%AC%EC%9A%A9%ED%95%9C-pagination
  • https://github.com/riley909/12-punch-assignment1-AIMMO#パフォーマンス-テスト-目的
  • 6.その他の注意事項

  • 確認して1つずつ確認し、要求を提出します.
  • READMEに心血を注いで、課題を行う過程を詳しく書けば書くほど良い
  • の郵便配達員でAPI集計表
  • に詳しく記入しましょう.
  • 提出時間遵守が基本の
  • 個人プロファイルがハブにアップロードされないように、.gitignore
  • を処理してください.