shields

นี่คือบ้านของ Shields.io บริการสำหรับป้ายรัดกุมสม่ำเสมอและชัดเจนในรูปแบบ SVG และ Raster ซึ่งสามารถรวมอยู่ใน GitHub Readmes หรือหน้าเว็บอื่น ๆ ได้อย่างง่ายดาย บริการรองรับบริการบูรณาการอย่างต่อเนื่องหลายสิบการลงทะเบียนแพ็คเกจการแจกแจงการจัดเก็บแอพเครือข่ายสังคมออนไลน์บริการครอบคลุมรหัสและบริการวิเคราะห์รหัส ทุกเดือนจะให้บริการมากกว่า 1.6 พันล้านภาพและใช้โดยโครงการโอเพนซอร์ซที่ได้รับความนิยมมากที่สุดในโลกบางรายการ VS Code, Vue.js และ Bootstrap เพื่อชื่อไม่กี่

โฮสต์ repo นี้:

• shields.io frontend และรหัสเซิร์ฟเวอร์
• ไลบรารี NPM สำหรับสร้างป้าย
  • เอกสาร
  • การเปลี่ยนแปลง
• ข้อกำหนดการออกแบบป้าย

ตัวอย่าง

• เปอร์เซ็นต์การครอบคลุมรหัส:
• รุ่นรีลีสเสถียร:
• Package Manager Release:
• สถานะของการพึ่งพาของบุคคลที่สาม:
• การวิเคราะห์รหัสสถิตเกรด:
• การสังเกตรุ่นเซมิเวอร์:
• จำนวนเงินบริจาค Liberapay ต่อสัปดาห์:
• ดาวน์โหลดแพ็คเกจ Python:
• การจัดอันดับส่วนขยายของ Chrome Web Store:
• เปอร์เซ็นต์หุ่นยนต์ uptime:

ทำป้ายของคุณเอง! (ตัวอย่างด่วน: https://img.shields.io/badge/left-right-f39f37 )

เร็ว

เรียกดูรายการป้ายที่สมบูรณ์และค้นหาตราเฉพาะโดยใช้แถบค้นหาหรือเรียกดูหมวดหมู่ คลิกที่ป้ายเพื่อเติมองค์ประกอบข้อมูลที่ต้องการสำหรับประเภทตรานั้น (เช่นชื่อผู้ใช้หรือ repo ของคุณ) และปรับแต่ง (ฉลากสี ฯลฯ ) และพร้อมใช้งานแล้ว!

ใช้ปุ่มที่ด้านล่างเพื่อคัดลอก URL ป้ายหรือตัวอย่างของคุณซึ่งสามารถเพิ่มเข้าไปในสถานที่เช่นไฟล์ readme gitHub ของคุณหรือหน้าเว็บอื่น ๆ

การบริจาค

Shields เป็นโครงการชุมชน เราเชิญการเข้าร่วมของคุณผ่านปัญหาและดึงคำขอ! คุณสามารถอ่านแนวทางที่มีส่วนร่วม

เมื่อเพิ่มหรือเปลี่ยนบริการโปรดเพิ่มการทดสอบ

โครงการนี้มีคำแนะนำค่อนข้างมาก! หากคุณยังใหม่กับโครงการบางทีคุณอาจต้องการเปิดคำขอดึงเพื่อที่อยู่หนึ่งในนั้น

คุณสามารถอ่านบทช่วยสอนเกี่ยวกับวิธีการเพิ่มป้าย

หากคุณตั้งใจที่จะรายงานหรือมีส่วนร่วมในการแก้ไขที่เกี่ยวข้องกับช่องโหว่ด้านความปลอดภัยโปรดอ้างอิงนโยบายความปลอดภัยของเราก่อน

การพัฒนา

1. ติดตั้งโหนด 20 หรือใหม่กว่า คุณสามารถใช้ตัวจัดการแพ็คเกจที่คุณเลือก การทดสอบจำเป็นต้องผ่านในโหนด 20 และ 22
2. โคลนที่เก็บนี้
3. เรียกใช้ npm ci เพื่อติดตั้งการพึ่งพา
4. เรียกใช้ npm start เพื่อเริ่มเซิร์ฟเวอร์ป้ายและเซิร์ฟเวอร์ dev frontend
5. เปิด http://localhost:3000/ เพื่อดูส่วนหน้า

เมื่อไฟล์ต้นฉบับของเซิร์ฟเวอร์เปลี่ยนไปเซิร์ฟเวอร์ตราควรรีสตาร์ทตัวเองโดยอัตโนมัติ (โดยใช้ Nodemon) เมื่อไฟล์ส่วนหน้าเปลี่ยนไปเซิร์ฟเวอร์ dev frontend ( docusaurus start ) ควรโหลดซ้ำโดยอัตโนมัติ อย่างไรก็ตามคำจำกัดความของป้ายถูกสร้างขึ้นก่อนที่เซิร์ฟเวอร์จะเริ่มขึ้นเป็นครั้งแรก ในการสร้างใหม่ให้เรียกใช้ npm run prestart หรือรีสตาร์ทเซิร์ฟเวอร์ด้วยตนเอง

ในการดีบักตราสัญลักษณ์จากบรรทัดคำสั่งให้เรียกใช้ npm run badge -- /npm/v/nock นอกจากนี้ยังใช้งานได้กับ URL เต็มรูปแบบเช่น npm run badge -- https://img.shields.io/npm/v/nock

ใช้ npm run debug:server เพื่อเริ่มต้นเซิร์ฟเวอร์ในโหมดดีบัก สูตรนี้แสดงวิธีการดีบักแอปพลิเคชัน Node.js ในรหัส VS

Shields ได้รับการสนับสนุนจากการทดลองสำหรับ Gitpod ซึ่งเป็นสภาพแวดล้อมการพัฒนาที่กำหนดค่าล่วงหน้าซึ่งทำงานในเบราว์เซอร์ของคุณ หากต้องการใช้ gitpod ให้คลิกปุ่มด้านล่างและลงชื่อเข้าใช้ด้วย GitHub Gitpod ยังมีส่วนเสริมเบราว์เซอร์แม้ว่าจะไม่จำเป็น โปรดรายงานข้อบกพร่องของ gitpod คำถามหรือคำแนะนำในปัญหา #2772

การทดสอบ Snapshot ทำให้แน่ใจว่าเราไม่ได้ทำการเปลี่ยนแปลงที่ส่งผลกระทบต่อ SVG หรือ JSON โดยไม่ได้ตั้งใจ เมื่อจงใจเปลี่ยนเอาต์พุตให้เรียกใช้ SNAPSHOT_DRY=1 npm run test:package เพื่อดูตัวอย่างการเปลี่ยนแปลง snapshots ที่บันทึกไว้และ SNAPSHOT_UPDATE=1 npm run test:package เพื่ออัปเดต

เซิร์ฟเวอร์สามารถกำหนดค่าให้ใช้ Sentry (การกำหนดค่า) และ Prometheus (การกำหนดค่า)

ชุดทดสอบเต็มรูปแบบของเรารวมถึงการครอบคลุมรหัสจะทำงานเป็นประจำทุกวัน

โฮสต์เซิร์ฟเวอร์ของคุณเอง

มีเอกสารเกี่ยวกับการโฮสต์เซิร์ฟเวอร์ของคุณเอง

โครงการที่เกี่ยวข้อง

ป้ายสถานะถูกใช้อย่างกว้างขวางในโครงการโอเพนซอร์ซและซอฟต์แวร์ส่วนตัว นักวิชาการได้ศึกษาป้าย "สัญญาณ" ให้เกี่ยวกับคุณภาพของโครงการซอฟต์แวร์ มีห้องสมุดที่มีอยู่มากมายสำหรับการแสดงผลตราเหล่านี้และทางเลือกในการให้บริการตราโล่ที่โฮสต์ Awesome-Badges เป็นคอลเล็กชั่นทรัพยากรดังกล่าว การมีส่วนร่วมอาจได้รับการพิจารณาที่นั่น (การปรากฏตัวของโครงการในคอลเลกชันนั้นไม่ควรตีความว่าเป็นการรับรองหรือการส่งเสริมจากโครงการ Shields)

ประวัติศาสตร์

b.adge.me เป็นเว็บไซต์ดั้งเดิมสำหรับบริการนี้ Heroku กลับมาแล้วมีสิ่งที่ทำให้ยากที่จะใช้โดเมน toplevel กับมันดังนั้นโดเมนแปลก ๆ มันใช้รหัสที่พัฒนาขึ้นในปี 2013 จากห้องสมุดที่เรียกว่า GH-Badges ทั้งคู่พัฒนาโดยThaddée Tyl โครงการรวมเข้ากับ shields.io โดยใช้รหัส b.adge.me และปิด b.adge.me

ข้อมูลจำเพาะตราเดิมได้รับการพัฒนาในปี 2013 โดย Olivier Lacan มันได้รับแรงบันดาลใจจาก Travis CI และป้ายที่คล้ายกัน (มีน้อยกว่ามากในตอนนั้น) ในปี 2014 Thaddée Tyl ออกแบบใหม่ด้วยความช่วยเหลือจากพนักงาน Travis CI และโน้มน้าวให้ทุกคนเปลี่ยนไป การออกแบบเก่าคือสิ่งที่เรียกว่าสไตล์พลาสติก ใหม่คือสไตล์แบน

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับการลงทะเบียนเรียนของโครงการแรงจูงใจของข้อกำหนดของตราสัญลักษณ์ SVG และข้อกำหนดของตัวเอง

ผู้นำโครงการ

ผู้ดูแล:

• Calebcartwright
• Chris48s
• jnullj
• Paulmelnikow
• pyvesb

ศิษย์เก่า:

• Daniel15
• espadrine
• olivierlacan
• แพลน
• redsparr0w

ใบอนุญาต

สินทรัพย์และรหัสทั้งหมดอยู่ภายใต้ใบอนุญาต CC0 และในโดเมนสาธารณะเว้นแต่จะระบุไว้เป็นอย่างอื่น

ชุมชน

ขอบคุณผู้คนและ บริษัท ที่บริจาคเงินบริการหรือเวลาเพื่อให้โครงการทำงาน https://shields.io/community