INTERNAL.md

Internal Only

Branch

• main
  • 不要傳會 action test fail 的程式碼
  • 照 Project 分工

基本設置

• 環境
  • Rust 2021
  • Git
  • Just
• 工具
  • VSCode
  • rust-analyzer
  • GitLens — Git supercharged
  • Better Comments
  • Error Lens

基本架構

• mady_math 放自動微分所需要的的數學函式及數學結構，像是Tensor、Matrix、Max、Min、Sigmoid、Relu、He、GradAdd 等等
• mady_macro 放解析自動微分 macro 的地方，有 #[grad]
• src 重定向用 (reexport)

基本原則

當有新的程式碼要PUSH先確認過以下幾點

1. just a 通過 (其他指令可以用 just -l 查看)
2. 確認並更改 Project
3. 有 breakthrough change 請另行討論

油圖

上傳程式碼前記得看一下油圖，養護身心靈

Commit Message

Event(Scope) Message

A list about the mean of emoji

Event

• ⚒️ WIP
• 🪲 Fix Bugs
• ✨ Feat
• ⚠️ Breakthrough Change
• 🔕 Internal Change
• 🔨 Refector
• 🚚 Change File/Dir
• ⚡ Release

Scope

• 🤖 Macro
• 🔢 Math
• 🦀 Src
• 🧪 Test
• 📚 example
• 💡 documentation