این ریپازیتوری برای جمع‌آوری مطالب درسی، جزوات، و منابع مرتبط با دروس دانشگاهی طراحی شده است. هدف اصلی این پروژه، آموزش عملی کار با Git و GitHub، آشنایی با فرآیندهای همکاری تیمی، و مدیریت محتوا در یک ریپازیتوری مشترک است.
- یادگیری و تسلط بر دستورات Git و فرآیندهای GitHub.
- تمرین همکاری گروهی و مدیریت یک ریپازیتوری تیمی.
- جمع‌آوری مطالب درسی مفید و منظم برای دانشجویان و ایجاد یک منبع قابل استفاده.
- رعایت مستندسازی و ثبت دقیق کارها.
اگر تاکنون حساب کاربری GitHub ندارید، به وب‌سایت GitHub مراجعه کنید و یک حساب کاربری جدید ایجاد کنید. داشتن یک حساب GitHub برای مشارکت در این پروژه ضروری است.
ابتدا ریپازیتوری پروژه را روی سیستم خود کلون کنید.
- به پوشه
Coursesدر ریپازیتوری بروید. - یک پوشه جدید برای درس خود ایجاد کنید. نام پوشه باید به صورت انگلیسی و مطابق با نام درس باشد.
- در داخل پوشه درس، یک فایل Markdown ایجاد کنید. نام فایل باید کوتاه و توصیفی باشد.
فایل Markdown خود را باز کرده و اطلاعات مرتبط با درس را در آن وارد کنید. می‌توانید شامل موارد زیر باشد:
- جزوات درسی
- نکات مهم درس
- تمرین‌ها و پروژه‌ها
- منابع آموزشی اضافی
در فایل contributors.md که در پوشه روت ریپازیتوری قرار دارد، نام و نام خانوادگی خود و درسی که روی آن کار کرده‌اید را در جدول اضافه کنید. مثال:
| شماره | نام و نام خانوادگی | درس |
|-------|--------------------|----------------------|
| 1 | علی رضایی | مباحث ویژه 1 |
| 2 | مریم حسینی | ریاضیات مهندسی |در پوشه‌ای به نام PersonalLogs که در ریشه ریپازیتوری قرار دارد:
- یک پوشه با نام کاربری یا نام خود ایجاد کنید.
- در داخل این پوشه، یک فایل Markdown با نام
log.mdبسازید و تمامی دستورات و فرآیندهایی که انجام داده‌اید را به صورت مستند در آن ثبت کنید.
- ملاک نمره دهی به پروژه شما بر اساس مستندات آن میباشد
- در این مستندات باید نشان دهید که تسلط کافی بر git/git hub را بدست آورده اید
- خلاقیت شما در انجام این پروژه ارزشمند بوده و باعث کسب نمره ی بیشتر میشود
پس از اعمال تغییرات، فایل‌ها را به Git اضافه و Commit کنید و تغییرات را به ریپازیتوری اصلی ارسال کنید. توجه داشته باشید که باید حتماً چندین Commit و Push برای ثبت تدریجی تغییرات خود انجام دهید.
برای ارسال تغییرات خود به ریپازیتوری اصلی، باید یک Pull Request ایجاد کنید. به صفحه ریپازیتوری در GitHub بروید، تغییرات خود را بررسی کنید و درخواست خود را ارسال کنید.
- مستندسازی الزامی است: تمامی دستورات Git که استفاده کرده‌اید باید در فایل Markdown مربوط به درس و همچنین فایل
log.mdدر پوشه شخصی شما نوشته شود. - چند Commit الزامی است: تغییرات خود را به صورت تدریجی و با چندین Commit ثبت کنید.
- استفاده از LLM ممنوع است: تمامی نوشته‌ها و تغییرات باید کار دست خودتان باشد.
- رعایت فرمت Markdown: فایل‌ها باید به صورت ساختاریافته و منظم نوشته شوند.
- نام‌گذاری پوشه‌ها و فایل‌ها: باید معنادار و انگلیسی باشد.
- Pull Request تمیز: فقط فایل‌های مرتبط با درس خود را تغییر دهید.
- حل Conflicts: اگر تعارضی در فایل‌ها ایجاد شد، باید آن را به صورت دستی حل کنید.
# عنوان درس: مباحث ویژه 1
## توضیحات کلی:
مطالب این فایل شامل نکات و جزوات مرتبط با درس مباحث ویژه 1 است.
## نکات کلیدی:
1. موضوع اول
2. موضوع دوم
## منابع اضافی:
- [منبع اول](http://example.com)
- [منبع دوم](http://example.com)
.
├── README.md
├── Courses/
│ ├── ExampleCourse/
│ │ └── example.md
├── PersonalLogs/
│ ├── username1/
│ │ └── log.md
│ ├── username2/
│ └── log.md
├── contributors.md
└── .gitignore
با رعایت این مراحل و قوانین، می‌توانید به صورت مؤثر در این پروژه مشارکت کنید و مهارت‌های خود را در Git و GitHub تقویت کنید.