-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
18 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,15 @@ | ||
# CONTRIBUTING | ||
|
||
## 文体など | ||
|
||
* 句読点は `,` `.` を使用します. | ||
* 地の分の文体は敬体とします.コード例の中のコメントは常体です. | ||
* タクティク `tactic` に対して,記事の名前は `tactic: (日本語による一言説明)` とします. | ||
* `src/SUMMARY.md` のタクティク記事は,アルファベット昇順に並べてください.VSCode だと `Tyriar.sort-lines` という拡張機能があって,並び替えを自動で行うことができます. | ||
* 使用例として紹介する Lean コードは,コンパイルが通るものに関しては `Examples` 配下に配置します.コンパイルが通らないものは,`.md` ファイルの中にコードブロックとして記述します. | ||
|
||
## コード例 | ||
|
||
* 使用例として紹介する Lean コードは,コンパイルが通るようにして `Examples` 配下に配置します.「タクティクが失敗する例」を紹介したいときであっても `try` を使ってコンパイルが通るようにしてください. | ||
* 新しいタクティクのコード例を追加したら,`Examples.lean` ファイルに追記してください. | ||
* Lean コードの中で `Mathlib` や `Std` 等のライブラリが必要になった際は,できるだけインポートする範囲を狭めて,必要なものだけインポートするようにしてください.それにより,どのタクティクがどのライブラリに依存しているのかが明確になります.また,動作も軽くなります.たとえば `ring` タクティクを使いたいときは,`import Mathlib.Tactic` ではなくて `import Mathlib.Tactic.Ring` とします. | ||
* `Mathlib` や `Std` 等のライブラリに依存する例を紹介する際には,それを明記します. | ||
* `Mathlib` や `Std` 等のライブラリに依存する例を紹介する際には,`needs: import ...` という形式でそれを明記します. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters