जरुरी

We are currently a small number of developers active on the project. As such, we cannot answer and tag all of the opened issues immediately, but we do notice and read them. Good bug reports provide us important feedback, which we thank you for and always appreciate.

बग रिपोर्ट गाइड

यस गाइडमा जेमीमा देखिएका बग र समस्याहरूको रिपोर्टिङका लागि चरण-दर-चरण निर्देशनहरू समावेश छन्।

आफ्नो वातावरणको व्यवस्था गर्नुहोस्

  • डाटा हानिको लागि तयार हुनुहोस्, आफ्नो खाताको ब्याकअप गर्नुहोस् र आफ्नो खातालाई सकेसम्म धेरै उपकरणहरूमा लिंक गर्नुहोस्।

  • जेमीको नवीनतम संस्करण (वा बेटा संस्करण) स्थापना गर्नुहोस्। पुरानो संस्करणहरूको तुलनामा बगहरू / मुद्दाहरूको रिपोर्ट गर्नु कम उपयोगी छ, र नयाँ संस्करणहरूमा पहिले नै ठीक भएको सम्भावना छ।

कसरी बग रिपोर्ट गर्ने

  1. [Jami GitLab]मा खाता सिर्जना गर्नुहोस् [https://git.jami.net/users/sign_up) यदि तपाईंसँग पहिले नै छैन भने।

  2. तपाईंको मुद्दालाई पोस्ट गर्न उपयुक्त परियोजना छनौट गर्नुहोस्ः

    • एन्ड्रोइड क्लाइन्ट

    • Qt ग्राहक

    • {gitlab-project}`IOS क्लाइन्ट

    • macOS क्लाइन्ट (<gitlab-project} Qt क्लाइन्ट <jami-client-qt>)

    • {gitlab-project}`जमी परियोजना सामान्यतया (वा यदि तपाईं निश्चित हुनुहुन्न भने)

    • [यदि तपाइँ जान्नुहुन्छ कि तपाइँ के गर्दै हुनुहुन्छ भने तपाइँ अन्य परियोजनाहरू मध्ये एक छनौट गर्न सक्नुहुन्छ]

  3. यदि तपाईंसँग धेरै समस्याहरू छन् भने, कृपया बिभिन्न बग रिपोर्टहरू फाइल गर्नुहोस्। यो तिनीहरूलाई ट्र्याक गर्न धेरै सजिलो हुनेछ।

  4. शीर्षक बगको स्पष्ट सारांश हो (उदाहरणः हेडर बार आइकन आकारको कारण धेरै ठूलो छ)

  5. बग पुनः उत्पादन गर्नका लागि निम्न चरणहरू पत्ता लगाउनुहोस्ः

    • यदि तपाईंसँग यसलाई पुनः उत्पादन गर्न सटीक चरणहरू छन् (महान! तपाईं उपयोगी बग रिपोर्ट सिर्जना गर्नको लागि बाटोमा हुनुहुन्छ।

    • यदि तपाईं कहिलेकाहीँ पुनः उत्पादन गर्न सक्नुहुनेछ, तर विशिष्ट चरणहरू पछ्याएपछि होइन भने, कृपया अरूलाई बुझ्न र यसलाई पुनः उत्पादन गर्न मद्दतको लागि यस विषयमा थप जानकारी दिनुहोस्।

    • If you can not reproduce the problem, there may be little chance of it being reasonably fixable. If you do report it, please try your best to provide as much information/clues about its occurrence as possible.

  6. तपाईँको सफ्टवेयर अद्यावधिक छ भन्ने कुरा निश्चित गर्नुहोस्। आदर्श रूपमा, तपाईँको बग पहिले नै ठीक भएको छ कि छैन भनेर हेर्नको लागि विकासमा रहेको संस्करणको परीक्षण गर्नुहोस्।

  7. वातावरणबाट अलग र पुनः उत्पादन गर्ने प्रयास गर्नुहोस् (जस्तै धेरै उपकरणहरूमा परीक्षण) ।

  8. निम्न कुराहरू निर्दिष्ट गरेर आफ्नो वातावरण वर्णन गर्नुहोस्ः

    • ओएस संस्करण

    • सटीक उपकरण मोडेल (मोबाइल उपकरणहरूको लागि महत्त्वपूर्ण)

    • यदि तपाईं बीटा संस्करण प्रयोग गर्दै हुनुहुन्छ भने

    • what build you are using (F-Droid, Play Store, App Store, from dl.jami.net, your own build, etc.). If you have built your own version of Jami, please specify the exact Jami Daemon version and client version (you can obtain it using jamid -v and jami -v; but note that our packages are updated quite often) and the Git commit.

    • network conditions:

      • are both devices on the same local network?

      • Different networks?

      • Is one or both behind NAT?

      • Are you using LTE?

      • Are you using WiFi?

    • other elements if needed:

      • SIP provider,

      • hardware,

      • etc.

स्पष्ट सारांश लेख्दै

तपाईं कसरी लगभग १० शब्द प्रयोग गरेर बग वर्णन गर्नुहुन्छ? यो तपाईंको बग रिपोर्टको पहिलो भाग हो जुन विकासकर्ताले देख्नेछ।

एउटा राम्रो सारांशले बग रिपोर्टको पहिचान तुरुन्त र अद्वितीय रूपमा गर्नुपर्छ। यसले समस्याको व्याख्या गर्नुपर्छ, तपाईंको सुझावित समाधान होइन।

Good: "Cancelling a file transfer crashes Jami"
Bad: "Software crashes"
Good: "All calls hang up after 32 seconds"
Bad: "Not able to call my friends"

पुनः उत्पादन गर्नका लागि सही कदमहरू लेख्दै

  • कसरी विकासकर्ताले आफ्नो उपकरणमा बगलाई पुनः उत्पादन गर्न सक्छ?

    बग् रिपोर्टको सबैभन्दा महत्त्वपूर्ण भाग बग्को पुनः उत्पादन गर्ने चरणहरू हुन्। यदि विकासकर्ताले बग्लाई पुनः उत्पादन गर्न सक्षम छ भने, यो बग ठीक हुने सम्भावना धेरै छ। यदि चरणहरू अस्पष्ट छन् भने, यो बग ठीक भएको छ कि छैन भनेर जान्न पनि सम्भव नहुन सक्छ। हामी पूर्ण रूपमा सचेत छौं कि केही बगहरू तपाईंलाई स्पष्ट देखिन सक्छन्, तर तिनीहरू तपाईंको वातावरणसँग सम्बन्धित हुन सक्छन्। तपाईं जति सटीक हुनुहुन्छ, त्यती छिटो बग ठीक गर्न सकिन्छ।

  • के कुराहरू बग रिपोर्टमा समावेश गर्नुपर्छ?

    यदि तपाईं कुनै पनि समयमा वा कुनै पनि समयमा त्रुटि पुनः उत्पादन गर्न सक्नुहुन्छ भने संकेत गर्नुहोस्। प्रत्येक चरणको उद्देश्यको अतिरिक्त Jami सँग अन्तर्क्रिया गर्ने तपाईंको विधि वर्णन गर्नुहोस्। तपाईंको चरणहरू पछि, अवलोकन गरिएको (वास्तविक) परिणाम र अपेक्षित परिणामको सटीक वर्णन गर्नुहोस्। तथ्यहरू (निरीक्षणहरू) स्पष्ट रूपमा अनुमानहरूबाट अलग गर्नुहोस्।

Good

म यी चरणहरू अनुसरण गरेर सधैं पुनः उत्पादन गर्न सक्छुः

1. Start Jami by clicking on the desktop icon
2. Start a new conversation with anyone
3. Click the file transfer icon

Expected results: A window opens and asks me to choose a file to send.
Actual results: When I click the file transfer icon, nothing happens.

Bad

Try to transfer a file.
It doesn't work.

प्राप्त परिणाम

कृपया निम्न कुराहरू समावेश गर्नुहोस्ः

  • जेमी डेमोन (जेमिड वा लिबजमी वा लिब्रिङ) र क्लाइन्ट डिबग लगहरू।

  • यदि एउटा उत्पादन भयो भने मूल डिम्बाइज।

अपेक्षित परिणाम

यो अपेक्षित वा चाहेको व्यवहारको वर्णन हो।

अतिरिक्त जानकारी प्रदान गर्दै

अधिकांश बग रिपोर्टहरूको लागि निम्न जानकारी अनुरोध गरिएको छ। तपाईं अपेक्षित परिणामहरू अन्तर्गत यो जानकारी प्रदान गरेर समय बचत गर्न सक्नुहुन्छ।

लकहरू

Qt आधारित Jami क्लाइन्ट (GNU/Linux, Windows, macOS)

Go to the General settings. In the Troubleshoot section, you can click on "Open logs", where you will be able to get statistics ("Show stats") or start recording information via "Receive logs". Then you can just copy the result and explain your scenario.

GNU/Linux मा

क्लासिक लॉगहरू (पूर्वनिर्धारित रूपमा केवल >= चेतावनी लॉगहरू मात्र लिइएको छ):

journalctl --since "24h ago" | grep jami

Full log: The Jami client (GUI) and daemon are separate processes. To obtain logs from both processes, start each process manually, one at a time.

  1. कुनै पनि Jami क्लाइन्ट वा daemon उदाहरणहरू चलिरहेको छैन भनेर सुनिश्चित गर्नुहोस्ः ps aux Grab jami` एक टर्मिनलमा चलाएर जाँच गर्नुहोस्।

    • जेमी अझै पनि दौडिरहेको हुन सक्छ यदि कुनै विन्डोहरू खुला छैनन् भने पनि, तपाईंको प्राथमिकतामा निर्भर गर्दछ।

    • यदि कुनै क्लाइन्ट वा डेमोन चलिरहेको छ भने, तिनीहरूलाई kill PID प्रयोग गरेर समाप्त गर्नुहोस्।

  2. एउटा टर्मिनलमा, jamid -d -c संग डेमोन सुरु गर्नुहोस्

    • यो कार्यान्वयन योग्य सामान्यतया PATH मा छैन, र डेबियन / Trisquel / Ubuntu प्याकेजहरूमा, यो /usr/lib/x86_64-linux-gnu/jamid -d -c वा /usr/libexec/jamid -d -c मा अवस्थित छ।

  3. In another terminal, start the client, using jami -d.

पछाडि पछ्याउनको लागि, तपाईँले GDB भित्र कार्यक्रम चलाउन सक्नुहुन्छः

gdb -ex run --args jami -d, or gdb -ex run --args /usr/libexec/jamid -cd, depending on the component you need to debug.

जब यो दुर्घटना हुन्छ, तपाईं टाइप गर्न सक्नुहुन्छ bt (वा अझ राम्रो, thread सबै bt लागू) त्यसपछि Enter थिच्नुहोस्। त्यसपछि ब्याकट्र्यास प्रतिलिपि गर्नुहोस् र यसलाई मुद्दामा टाँस्नुहोस्।

म्याकोसमा

  • /Applications/Jami.app/Contents/MacOS/ मा नेभिगेट गर्नुहोस्।

  • डबल क्लिक गर्नुहोस्, यसले जेमीलाई प्रक्षेपण गर्नेछ र टर्मिनलमा लग प्रिन्ट गर्नेछ।

  • टर्मिनलबाट फाइलमा लग प्रतिलिपि गर्नुहोस्।

वैकल्पिक रूपमा, तपाईं टर्मिनलबाट /<path to Jami>/Jami.app/Contents/MacOS/Jami -d चलाउन सक्नुहुनेछ।

एन्ड्रोइडमा

जेमीको प्रयोग गरेर फोनबाट लगहरू संकलन गर्नः

  • वार्तालाप

  • दायाँ माथिल्लो भागमा तीन बिन्दु मेनुमा थिच्नुहोस्

  • सेटिङहरू

  • निदानको अभिलेख

एन्ड्रोइड डिबग ब्रिज (adb) प्रयोग गरेर आफ्नो कम्प्युटर मार्फत लगहरू संकलन गर्नः

  • तपाईँको कम्प्युटरमा एडबी सेटअप गर्नु आवश्यक छ।

  • आफ्नो स्मार्टफोनमा Jami सुरु र त्यसपछि कार्यान्वयन

  • ```db logcat *:D ♬ grep adb shell ps egrep 'cx.ring' cut -c10-15d > logring.txt``

  • अब तपाईंसँग ग्राहकको लग समावेश गर्ने फाइल छ

विन्डोजका लागि

एउटा टर्मिनल खोल्नुहोस् (cmd.exe) र निम्न विकल्पहरूको साथ Jami.exe सुरू गर्नुहोस्ः

  • -d लेगहरू प्राप्त गर्न छुट्टै कन्सोल विन्डो खोल्न

  • -f %localappdata%\jami\jami.log लाई लगहरू लेख्न