mirror of
https://github.com/AmirAref/paya-university-fault-system.git
synced 2026-11-03 14:49:38 +00:00
update contributing.md file
This commit is contained in:
@@ -72,6 +72,29 @@ git push -u origin aref-tasks
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## ۶. رسم نمودار با Mermaid
|
||||||
|
|
||||||
|
برای رسم نمودارها (مثل Class Diagram) از ابزار [Mermaid](https://mermaid.js.org/) استفاده کنید.
|
||||||
|
نمودار بهصورت متن نوشته میشود، بنابراین تغییرات آن در Git قابل مشاهده و بازبینی است. گیتهاب این نمودارها را مستقیم در فایلهای `.md` نمایش میدهد.
|
||||||
|
|
||||||
|
مثال یک Class Diagram:
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
classDiagram
|
||||||
|
class Report {
|
||||||
|
+id: int
|
||||||
|
+status: string
|
||||||
|
+submit()
|
||||||
|
}
|
||||||
|
class Technician {
|
||||||
|
+name: string
|
||||||
|
+assign(report)
|
||||||
|
}
|
||||||
|
Technician "1" --> "*" Report : repairs
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## نکات مهم
|
## نکات مهم
|
||||||
|
|
||||||
- همیشه قبل از شروع کار جدید، آخرین تغییرات `CONTRIBUTINGmain` را بگیر:
|
- همیشه قبل از شروع کار جدید، آخرین تغییرات `CONTRIBUTINGmain` را بگیر:
|
||||||
|
|||||||
@@ -41,3 +41,5 @@
|
|||||||
## نحوه همکاری
|
## نحوه همکاری
|
||||||
|
|
||||||
هر عضو تیم با اکانت شخصی خود محتوا را اضافه یا اصلاح میکند تا تاریخچه Commitها نشاندهندهٔ سهم هر نفر باشد.
|
هر عضو تیم با اکانت شخصی خود محتوا را اضافه یا اصلاح میکند تا تاریخچه Commitها نشاندهندهٔ سهم هر نفر باشد.
|
||||||
|
|
||||||
|
برای جزئیات بیشتر درباره نحوهٔ کار با برنچها و Pull Request، [راهنمای همکاری (CONTRIBUTING.md)](CONTRIBUTING.md) را ببینید.
|
||||||
|
|||||||
Reference in New Issue
Block a user