TWE: Dev: Design System: Create Elevation Shadows
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 52/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- html, markdown, sass
- Lĩnh vực
- design, documentation, frontend
Hướng nghiên cứu
Bắt đầu bằng cách đọc CONTRIBUTING.md và xem lại mockup Elevation Shadows trong Figma, sau đó kiểm tra /docs, mkdocs.yml và các tệp hiện có trong /docs/components/sass/components. Tạo elevation.md và elevation.scss với các token, trạng thái component, snippet và liên kết tệp bắt buộc; kiểm tra frontend của microsite, tạo một PR và kết nối component đã được merge với Figma.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Dependencies
#541
Overview
We need to create Design System Elevation Shadows Component HTML and SASS / connect Figma design to finished code, and build microsite page so that developers can see and easily change component examples, states, code and location.
Assumptions
- You have read the CONTRIBUTING.md in the Design System repo
- You have set up your development environment for working with the Internship Design System Repository: https://github.com/hackforla/internship-website-design-system
- You will continue to follow the instructions in CONTRIBUTING.md file
Action Items
- Review the Microsite page mockup you will be working from (Resource 1.01)
- Review the Material Design Kit and identify the relevant component, variants, and states (Resource 1.13)
- Review Code Standards before starting implementation
- Name the Branch you create
elevation - Determine if any JavaScript needs to be included to style this component (see Resource 1.02 for examples of included JavaScript). If you do need to use JS, don't forget to update the wiki page
- Include necessary files in the
/docsfolder (Resource 1.03) and project config filemkdocs.yml(Resource 1.04) - Determine what tokens are needed for this component
- Reuse existing tokens where possible
- Add new tokens only if necessary
- Code Microsite component page
- file locations
- md file goes into the /docs folder (Resource 1.03)
- SASS file goes into the /docs/components/sass/components folder (Resource 1.06)
- Create tokens as necessary, reusing existing tokens where possible; add new color tokens only if required and name them using HTML Color Code conventions (Resources 1.07, 1.08)
- Create component classes and states within the page
- Include Files via code snippets to create the code section (see Resource 1.09 for details)
- Add links to SASS and Markdown files below the code (see examples in Resource 1.10)
- file locations
- Review template frontend for errors
- Make a PR
- Once PR is merged
- connect component in Figma to GitHub Files (Resource 1.10)
- Add links to
Resources gathered during the completion of this issuesection- 2.01 MD file(s) created
- 2.02 SASS file(s) created
- 2.03 link to Header Microsite page on live site: If the site is live when this issue is worked on.
Resources
Resources for working on this issue
- 1.01 Design Reference
- 1.02 WIKI: Design system microsite JavaScript
- 1.03 MKdocs folder: /docs on repo
- 1.04 MDdocs config file: mkdocs.yml on repo
- 1.05 variables file: /docs/components/sass/abstracts/_variables.scss on repo
- 1.06 SASS file folder: /docs/components/sass/components
- 1.07 Variables SASS Sheet: /docs/components/sass/abstracts/variables.sss
- 1.08 HTML Color Code Names: HTMLColorCodes.com
- 1.09 WIKI: How to Create a Design System Microsite Page using Snippets
- 1.10 Naming conventions:
- below the CSS tab, it would say CSS: https://github.com/hackforla/internship-website-design-system/blob/main/docs/components/sass/components/_elevation.scss
- below the HTML tab it would say HTML: https://github.com/hackforla/internship-website-design-system/blob/main/docs/elevation.md
- 1.11 Connect component in Figma to GitHub Files
- 1.12 Original Design Issue: #541
- 1.13 Material Design Kit (Figma)
- Microsite Epic Issue with list of design issues: #824
Resources gathered during the completion of this issue
- 2.01 MD file(s) created: [elevation.md] - link the name to the file in the repo
- 2.02 SASS file(s) created: [elevation.scss] - link the name to the file in the repo
- 2.03 link to Header Microsite page on live site: [Elevation Shadows](Replace with - link to the live URL If the site is live when this issue is worked on.
- Ngôn ngữ chính
- CSS
- Star
- 20
- Fork
- 6
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của hackforla/internship
-
documentation help wanted question
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
hackforla/internship#835 ·
-
TWE Design System: Create Microsite Documentation Standards and Contributor GuidelinesCó thể làm lại được @revforyou đã nhận 139 ngày trước và không có pull request nào đang mở. Đang mởcomplexity: small feature: design system role: engineering size: 1pt
hackforla/internship#831 · 1 người được giao ·
-
TWE: Dev: Design System: Update Toggle with TokensCó thể làm lại được @zvidmarb đã nhận 160 ngày trước và không có pull request nào đang mở. Đang mởcomplexity: small feature: design system Participant Type: TWE Team Member role: engineering size: 1pt
hackforla/internship#830 · 1 người được giao ·
-
complexity: medium feature: design system Participant Type: TWE Team Member role: engineering size: 2pt
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 55/100
hackforla/internship#828 ·
-
complexity: medium feature: board / google drive / tools feature: design system Participant Type: TWE Team Member role: engineering size: 2pt
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 65/100
hackforla/internship#827 ·
Tất cả issue của hackforla/internship
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
commercetools/nimbus#2149 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Use the brand yellow for the Am I a Bot? bannerCó thể đã có người làm @Rabia-Ghafoor đã nhận hôm nay. Đang mởgood first issue help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
layer5io/blowhorn-site#374 · 3 bình luận ·
-
E-ink theme: selected options are invisible (desktop settings, sidebar nav, mobile pickers)Có thể đã có người làm @colherdesopa đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
dongdongbh/Mindwtr#1493 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Request: hltv.orgĐang mởnew icon permissions in review
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 63/100
simple-icons/simple-icons#15119 ·
Maintainer thường phản hồi trong vòng 1 ngày