search

dbgroup-nagoya-u / paper-lintrules

論文校正ツール
0 stars 0 forks source link

Modify comment rule to avoid too long runs #120

Closed Yang-33 closed 4 years ago

Yang-33 commented 4 years ago

116 でコメントの扱いを正しいものに修正しましたが、可変長後読みのせいでたくさんコメントのあるtexファイルの処理が終わらなくなっていたので、元に戻しました。

texファイル内で<>が使われているとreviewdog読み込めなくなっている部分も同時に修正しました。（同時に修正するのはあまり良くない）

github-actions[bot] commented 4 years ago

このPull Requestではtextlintが走ります:rocket: 適宜update.bashを使用してtextlintの設定を更新してください。

執筆の流れ

  1. 最初はReviewerを追加せず、このPull Requestで執筆と修正を続けてください。可能な限りtextlintが指摘を行います。
  2. 修正が完了し、Reviewerに添削をお願いできる状況になったら、 .github/workflows/textlint.ymlと.github/workflows/comment-open-pull-request.ymlを削除してください。 以降のcommitに対してはtextlintによる指摘が行われなくなります。
  3. commit後、一度このPull RequestをCloseしてください。ブランチはClose後も残るため、作業内容はGitHubに保存されています。
  4. Reviewerを追加する際は同じブランチ（通常はdevelop）をもとに別のPull Requestを作成し、そこでReviewを開始してください。
    • Review commentの数が100に近づくとページの表示が重くなります。 Textlintの修正が多い場合・Review前にはPull Requestを切り替えると快適に作業ができます。

バグ報告

おかしな指摘・指摘されていないが今後プログラムで指摘可能なルールを発見した場合は、 今後のためにこちらから指摘をお願いします:smiley:

執筆頑張ってください！