testing-handbook

Trail of Bits परीक्षण हैंडबुक - appsec.guide

अध्याय

✅ जारी

🎥 वेबिनार

🚧 निर्माणाधीन

• kAFL
• Rust
• फॉर्मल वेरिफिकेशन और टैमरिन

योगदान कैसे करें

यदि आप टेस्टिंग हैंडबुक में योगदान देना चाहते हैं, तो आरंभ करने में आपकी सहायता के लिए यहां कुछ दिशानिर्देश दिए गए हैं:

1. नया उपकरण जोड़ें: यदि आप टेस्टिंग हैंडबुक में किसी नए उपकरण को शामिल करना चाहते हैं, तो GitHub Issues में एक विषय प्रस्तावित करें। उसके बाद, आप एक नया पुल रिक्वेस्ट पर काम कर सकते हैं।
2. मौजूदा अध्यायों में सुधार करें: यदि आपके पास किसी विशिष्ट अध्याय को बेहतर बनाने का विचार है, तो आप एक GitHub इश्यू जोड़ सकते हैं।
3. छोटे कार्य उठाएँ: यदि आपके पास अधिक समय नहीं है लेकिन फिर भी योगदान देना चाहते हैं, तो आप GitHub इश्यू सूची से कोई भी छोटा कार्य उठा सकते हैं।
4. समस्याओं की रिपोर्ट करें: यदि आपको कोई छोटी तकनीकी समस्या या टाइपो मिलता है, तो एक नया GitHub इश्यू बनाएँ और/या नए पुल रिक्वेस्ट में इसे ठीक करें।

सुविधाजनक विकास के लिए त्वरित सेटअप

1. अपने सिस्टम में Hugo स्थापित करें

   root@kitploit:~

   brew install hugo
   

2. रिपॉजिटरी को क्लोन करें

   root@kitploit:~

   git clone --recurse-submodules https://github.com/trailofbits/testing-handbook.git
   

3. एक नई शाखा बनाएँ या वह शाखा चुनें जिस पर आप काम करना चाहते हैं

   root@kitploit:~

   cd testing-handbook
   # फिर
   git checkout -b name-of-your-new-branch
   # या
   git checkout name-of-existing-branch
   

4. Hugo सर्वर को ड्राफ्ट चालू करके (-D) प्रोजेक्ट की रूट डायरेक्टरी से चलाएँ। जब भी आप फ़ाइल सहेजते हैं तो आपका ब्राउज़र स्वचालित रूप से परिवर्तनों के साथ रिफ़्रेश हो जाएगा।

   root@kitploit:~

   hugo server -D
   

5. "doc" के रूप में एक नया उपकरण जोड़ें, और प्रोजेक्ट की रूट डायरेक्टरी से निम्नलिखित चलाएँ।

   root@kitploit:~

   hugo new docs/<उपकरण का नाम>
   

   नोट: यह प्रोजेक्ट zkdocs के समान ही hugo टेम्पलेट का उपयोग करता है। टेम्पलेट प्रत्येक नए पृष्ठ को पोस्ट के बजाय "doc" के रूप में संदर्भित करता है। यही कारण है कि आप hugo new docs/<उपकरण का नाम> टाइप करना चाहेंगे और post/my-new-post नहीं।

6. अपने परिवर्तनों को main में मर्ज करने के लिए संपादित करें, जोड़ें और पुल रिक्वेस्ट बनाएँ।

7. ❗ध्यान रखें कि जब आप अपने PR को main में मर्ज करते हैं, तो सामग्री https://appsec.guide पर लाइव हो जाती है। हमारी वर्तमान नीति मर्ज करने से पहले कम से कम एक समीक्षा को अनिवार्य करती है।

8. होम पेज में अपडेट के लिए, content/_index.md संपादित करें

दिशानिर्देश

• प्रारूप प्रत्येक "doc" के बीच सुसंगत होना चाहिए। एक नया doc जोड़ते समय (यानी, एक नया उपकरण जोड़ते समय), content/docs/template.md में टेम्पलेट का पालन करें। आवश्यकतानुसार सुझाए गए परिवर्तनों के साथ इस फ़ाइल के लिए एक PR भेजें।

• अपने परिवर्तनों के साथ एक नई शाखा बनाएँ, और जब आप काम पूरा कर लें तो main में मर्ज करने के लिए एक PR बनाएँ।

• इस रिपॉजिटरी में GitHub वर्कफ़्लो तीन जाँचों के माध्यम से Markdown फ़ाइलों की शुद्धता को सत्यापित करता है:

  1. Markdown लिंक जाँच: यह चरण Markdown फ़ाइलों से लिंक निकालता है और सत्यापित करता है कि वे मान्य और सुलभ हैं। यह lychee लिंक चेकिंग एक्शन का उपयोग करता है।
  2. Markdown Linter: यह चरण सुनिश्चित करता है कि Markdown फ़ाइलें वांछित शैली और फ़ॉर्मेटिंग नियमों का पालन करती हैं। यह एक कस्टम कॉन्फ़िगरेशन फ़ाइल (.github/workflows/.markdownlint.jsonc) और markdownlint-cli2-action एक्शन का उपयोग करता है। टेस्टिंग हैंडबुक पर काम करते समय बेहतर उपयोगकर्ता अनुभव के लिए Visual Studio Code के साथ markdownlint एक्सटेंशन का उपयोग करें।
  3. वर्तनी जाँच: यह चरण Markdown फ़ाइलों में वर्तनी की जाँच करता है (retext और remark के ऊपर निर्मित)। tbroadley/spellchecker-cli-action एक्शन का उपयोग करता है।

• Hugo बुक थीम से परिचित हों क्योंकि इसमें कुछ अच्छी सुविधाएँ हैं (बटन, आदि)

• यदि आपके कोई प्रश्न हैं, तो #testing-handbook एम्पायर हैकिंग स्लैक में संपर्क करें।

संपादन

लेखन दिशानिर्देश

• "Testing Handbook" शब्द को हर बार जब यह वेबसाइट पर दिखाई दे (चाहे वह हेडर/सबहेडर में हो या चलते पाठ में) बड़े अक्षरों में लिखा जाना चाहिए, क्योंकि यह एक दस्तावेज़ का शीर्षक है। लेकिन यदि आप इस पूंजीकरण से बचना चाहते हैं क्योंकि यह अजीब लगता है, तो आप "Testing Handbook" के बजाय "this handbook" (this handbook) का उपयोग कर सकते हैं (क्योंकि हैंडबुक का शीर्षक क्या है, यह काफी स्पष्ट है)।

कार्यप्रवाह: Google Docs से

आप Google Docs से दस्तावेज़ को Markdown के रूप में निर्यात कर सकते हैं। Google Docs में दस्तावेज़ खोलें। File > Download पर क्लिक करें, और फिर Markdown (.md) चुनें।

कस्टम वातावरण