← ყველა პრომპტი
ქმნის პროექტის დოკუმენტაციას ინსტალაციით და გამოყენების მაგალითებით
დამიწერე README.md ჩემი პროექტისთვის. პროექტი: [სახელი და რას აკეთებს]. ტექნოლოგიები: [ჩამოთვალე]. კოდი ან ფაილების სტრუქტურა: [ჩასვი]. ჩართე: მოკლე აღწერა, ინსტალაცია, გაშვება, გამოყენების მაგალითი, კონფიგურაცია (გარემოს ცვლადები), პროექტის სტრუქტურა, ლიცენზია. ბრძანებები კოდის ბლოკებში ჩასვი. ფუნქციები, რომლებიც კოდში არ ჩანს, არ მოიგონო — უცნობი ადგილები [TODO]-თი მონიშნე. ენა: [ქართული/ინგლისური].
როდის გამოვიყენო
როცა პროექტი GitHub-ზე უნდა განათავსო ან გუნდს გადასცე და დოკუმენტაცია არ გაქვს. კარგი README ახალ ადამიანს ეხმარება, რომ პროექტი შენი დახმარების გარეშე გაუშვას.
რა უნდა შეავსო
- [სახელი და რას აკეთებს]
- [ჩამოთვალე]
- [ჩასვი]
- [TODO]
- [ქართული/ინგლისური]
როგორ გამოვიყენო
- დააკოპირე პრომპტი ღილაკით ან გახსენი პირდაპირ ჩატბოტში.
- ჩასვი კოდი, error-ის სრული ტექსტი და მიუთითე ენა, ვერსია და გარემო.
- მიღებული კოდი ჯერ ლოკალურად ან სატესტო გარემოში გაუშვი და შემდეგ გადაიტანე პროექტში.
- თუ რამე არ მუშაობს, ახალი error იმავე ჩატში ჩასვი, რომ კონტექსტი არ დაიკარგოს.
პასუხის ნიმუში
შევსებული ფრჩხილები: პროექტი: Telegram ბოტი, რომელიც ვალუტის კურსს აჩვენებს, Python
# currency-bot
Telegram ბოტი, რომელიც ბრძანებაზე ვალუტის მიმდინარე კურსს აბრუნებს.
## ინსტალაცია
pip install -r requirements.txt
## გაშვება
BOT_TOKEN=... python bot.py
## გამოყენება
/rate USD
ნიმუში საილუსტრაციოა: ჩატბოტის პასუხი შენს მონაცემებზე იქნება დამოკიდებული.
მსგავსი პრომპტები
- Python სკრიპტი რუტინული საქმის ავტომატიზაციისთვის წერს მზა სკრიპტს ფაილებთან, Excel-თან ან ტექსტთან განმეორებადი სამუშაოსთვის
- Git commit-ის შეტყობინება ცვლილებებიდან წერს მკაფიო commit-ს Conventional Commits ფორმატით
- Excel ფორმულის შექმნა წერს Excel-ის ან Google Sheets-ის ფორმულას და ხსნის, როგორ მუშაობს
- კოდის ახსნა ხსნის უცნობ კოდს გასაგებად
- ვებ-აპლიკაციის შექმნა ქმნის პროექტის სტრუქტურას
- კოდის ტესტების შექმნა წერს ტესტებს ძირითადი ქცევების, შეცდომებისა და ზღვრული შემთხვევების შესამოწმებლად