Add to quick start documentation: once you create a case, do not change the sandbox

オープン
#129 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

  • #437 @monsterlag による — マージされずにクローズ

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
領域
documentation

調査の方向性

CESM/CIME のクイックスタートガイドを読み、case の作成について説明されている箇所を特定してください。case が完了するまで source directory 内のチェックアウト済みコードを変更してはならないことを明確に警告する文を追加してください。できれば重要なポイントのセクションに追加します。クイックスタートドキュメントに警告が存在し、周囲のコンテンツと一貫してレンダリングされれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

A seemingly unintuitive aspect of CESM/cime is that, once you have created a case from a particular directory, it is very important not to change the code checked out in that directory until you are completely done with your case. Is that documented somewhere? I don't see it in the quick start guide, and that seems like a good place to include a warning about this. Maybe we can have a section at the end like "Important points to bear in mind"?

主要言語
Python
スター
495
フォーク
253
平均マージ
34分
マージ済み PR(30日)
4

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ESCOMP/CESM のほかの issue

ESCOMP/CESM の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。