გადადით შინაარსზე

შეცდომების შეტყობინება

Tuist-ის მომხმარებლის სახით, შეიძლება შეაწყდეთ შეცდომებს ან მოულოდნელ ქცევებს. თუ ასე მოხდა, გირჩევთ, შეატყობინოთ ისინი, რათა ჩვენ შევძლოთ მათი გამოსწორება.

GitHub issues არის ჩვენი საბუღალტრო პლატფორმა#

შეცდომები უნდა იყოს შეტყობინებული GitHub-ზე, როგორც GitHub issues, და არა Slack-ში ან სხვა პლატფორმებზე. GitHub უკეთესია შეცდომების კვლევისა და მართვისთვის, უფრო ახლოსაა კოდთან და საშუალებას გვაძლევს თვალყური ვადევნოთ პრობლემის პროგრესს. გარდა ამისა, ის ხელს უწყობს პრობლემის დეტალურ აღწერას, რაც აიძულებს მომხსენებელს, უფრო ღრმად დაფიქრდეს პრობლემაზე და მეტი კონტექსტი მიაწოდოს.

კონტექსტი გადამწყვეტია#

შეცდომა საკმარისი კონტექსტის გარეშე ჩაითვლება არასრულყოფილად და ავტორს სთხოვენ დამატებითი კონტექსტის მიწოდებას. თუ ეს არ მოხდება, შეცდომა დაიხურება. ფიქრობდით ასე: რაც უფრო მეტ კონტექსტს მოაწვდით, მით უფრო ადვილი იქნება ჩვენთვის პრობლემის გაგება და მისი გამოსწორება. ამიტომ, თუ გსურთ, რომ თქვენი შეცდომა გამოსწორდეს, მოაწოდეთ რაც შეიძლება მეტი კონტექსტი. სცადეთ უპასუხოთ შემდეგ კითხვებს:

  • რა ცდილობდით გააკეთოთ?
  • როგორ გამოიყურება თქვენი გრაფი?
  • Tuist-ის რომელ ვერსიას იყენებთ?
  • არის თუ არა ეს თქვენთვის ბლოკირება?

ჩვენ ასევე მოვითხოვთ, რომ მოაწოდოთ მინიმალური reproducible project.

Reproducible project#

რა არის reproducible project?#

Reproducible project არის მცირე Tuist პროექტი, რომელიც აჩვენებს პრობლემას - ხშირად ეს პრობლემა გამოწვეულია Tuist-ის შეცდომით. თქვენი reproducible project უნდა შეიცავდეს მინიმალურ ფუნქციებს, რომლებიც საჭიროა შეცდომის ნათლად საჩვენებლად.

რატომ უნდა შექმნათ reproducible test case?#

Reproducible projects საშუალებას გვაძლევს გამოვყოთ პრობლემის მიზეზი, რაც პირველი ნაბიჯია მისი გამოსწორებისკენ! ნებისმიერი შეცდომის შეტყობინების ყველაზე მნიშვნელოვანი ნაწილია ზუსტი ნაბიჯების აღწერა, რომლებიც საჭიროა შეცდომის გამოსაწვევად.

Reproducible project არის შესანიშნავი გზა კონკრეტული გარემოს გასაზიარებლად, რომელიც იწვევს შეცდომას. თქვენი reproducible project არის საუკეთესო გზა, რომ დაეხმაროთ იმ ადამიანებს, ვინც გსურთ დაგეხმაროთ.

ნაბიჯები reproducible project-ის შესაქმნელად#

  • შექმენით ახალი git repository.
  • ინიციალიზაცია პროექტის გამოყენებით tuist init repository-ის დირექტორიაში.
  • დაამატეთ კოდი, რომელიც საჭიროა იმ შეცდომის ხელახლა წარმოქმნისთვის, რომელიც ნახეთ.
  • გამოაქვეყნეთ კოდი (თქვენი GitHub ანგარიში კარგი ადგილია ამისთვის) და შემდეგ მიუთითეთ მასზე, როდესაც შექმნით შეცდომას.

Reproducible projects-ის სარგებელი#

  • უფრო მცირე ზედაპირი: შეცდომის გარდა ყველაფრის ამოღებით, არ გჭირდებათ ძიება შეცდომის საპოვნელად.
  • არ არის საჭირო საიდუმლო კოდის გამოქვეყნება: შეიძლება არ შეგეძლოთ თქვენი მთავარი საიტის გამოქვეყნება (ბევრი მიზეზის გამო). მისი მცირე ნაწილის ხელახლა შექმნა, როგორც reproducible test case, საშუალებას გაძლევთ საჯაროდ აჩვენოთ პრობლემა საიდუმლო კოდის გაუთქმელად.
  • შეცდომის მტკიცებულება: ზოგჯერ შეცდომა გამოწვეულია თქვენს მანქანაზე პარამეტრების გარკვეული კომბინაციით. Reproducible test case საშუალებას აძლევს მომხმარებლებს ჩამოიტანონ თქვენი build და შეამოწმონ ის თავიანთ მანქანებზეც. ეს ეხმარება პრობლემის მიზეზის დადასტურებასა და შევიწროებას.
  • მიიღეთ დახმარება თქვენი შეცდომის გამოსწორებაში: თუ ვინმე სხვა შეძლებს თქვენი პრობლემის გამოსაწვევას, მათ ხშირად აქვთ კარგი შანსი პრობლემის გამოსწორების. თითქმის შეუძლებელია შეცდომის გამოსწორება, თუ ჯერ არ შეგიძლიათ მისი გამოსაწვევი.