mirror of
https://github.com/sethcottle/littlelink.git
synced 2025-03-12 18:36:44 -04:00
3.0 KiB
3.0 KiB
📄 Description
✅ Contribution Checklist
Please confirm that you've met the following criteria before submitting your contribution:
- Widespread Recognition: The brand has widespread recognition and is suitable for the core LittleLink repository (most additions belong in LittleLink Extended).
- Brand Styling Guidelines: You’ve followed the brand's official styling guidelines (if available).
- Consistent Styling: If no guidelines exist, the button style is consistent with the brand's public image (e.g., website, social media).
- Icon Clarity: The brand's logo/icon is clear and recognizable in a 24x24px format.
- If the primary logo doesn’t scale well, you’ve adapted it using the brand’s social media avatar or favicon while maintaining the essence of the original logo.
- The icon is provided in
.svg
format.
- Theme Testing: You've tested the button against both light and dark themes:
- Manually swapped
theme-auto.css
withtheme-light.css
andtheme-dark.css
inindex.html
to check contrast or used LittleLink Button Builder contrast checker. - Added a
#000000
/#FFFFFF
stroke if necessary to improve contrast and accessibility. LittleLink Button Builder will automatically recommend when to add a stroke.
- Manually swapped
- Accessibility Compliance: The button's background and text colors meet visual accessibility standards (unless it contradicts brand guidelines).
- Alphabetical Order: Your contribution is alphabetically organized in
brands.css
andindex.html
. - Button Preview: You've added a button preview in
index.html
. - Variant Naming Schema: If adding a variant button (e.g., inverted color scheme):
- Naming follows the existing pattern (
[Brand Name] Alt
and.button-brandname-alt
). - Any additional icons are named according to
brandname-alt.svg
schema.
- Naming follows the existing pattern (
- Proper Capitalization:
- In
brands.css
, the brand name comment follows/* Brand Name */
format. - Code uses lowercase for
.button.button-brandname
. - In
index.html
, comments reflect<!-- Brand Name -->
format. - Button text and
alt
attributes match the brand’s official capitalization.
- In
- PR Details:
- Included a brief description of the brand addition.
- Included a screenshot of the new button(s).
- Provided relevant information on the brand’s global/regional reach or usage stats.