CONTRIBUTING.md

مشارکت در پروژه ترنج

فهرست

| لیست قابلیت‌هایی که باید به پروژه اضافه بشوند
| پیش‌نیازها و مراحل راه‌اندازی و اجرای پروژه
| نحوه اسم گذاری کامیت‌ها
| نحوه اسم‌گذاری اجزای پروژه

---

لیست قابلیت‌هایی که باید به پروژه اضافه بشوند

1. ایجاد سناریو به همراه چندین خروجی
2. ایجاد چندین سناریو بر روی یک فایل اطلاعات

---

پیش‌نیازها و مراحل راه‌اندازی و اجرای پروژه

نصب و راهاندازی فرانت

1- استفاده IDE وب استورم

2- نود نسخه ^12.4 و یا ^14.15 و npm مناسب با آن

3- آنگولار 12.2.1 که میتوانید با کد زیر، سی‌ال‌آی اون رو نصب کنید:

npm i -g @angular/[email protected]

4- اضافه کردن پیکیج‌ها و آنگولار به پروژه با دستور:

npm install

5- فعال کردن کد فرمترها برای پیروی از قوانین و چارچوب کدنویسی تیم

6- پس از تکمیل میتوانید با اجرای دستور زیر پروژه را اجرا کنید

ng serve

---

نحوه اسم گذاری کامیت‌ها

[نوع کامیت همه حروف با UPPERCASE] توضیح کامیت همگی با حروف lowerCase
مثال:

[ADD] pop-up menu to shopping cart button

لیست اسم گذاری کامیت‌ها:
| [INIT] افزودن فایل اولیه
| [ADD] اضافه کردن کد و یا فیچر که قبلا وجود نداشت
| [FIX] اصلاح کردن کد و یا فیچر قبلی که ایراد داشت
| [UPDATE] بهبود قسمتی از کد یا سند
| [DEL] پاک کردن کد و یا فیچر قبلی

---

نحوه اسم گذاری اجزای پروژه

فایل ها

نام گذاری فایل ها به صورت kebab-case باید باشد

مثال : test-file.ts

تابع ها و متغیر ها

نام گذاری توابع و متغیر ها به صورت camelCase باید باشد

مثال : testVariable

کامپوننت ها، مدل ها و enum ها

نام گذاری کامپوننت ها و مدل ها باید به صورت PascalCase باشد

مثال: TestComponent