TWE: Dev: Design System: Create Snackbar
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 65/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- css, html, markdown, sass, scss, yaml
- 领域
- design, documentation, frontend
调研方向
先从 Snackbar 微站页面 mockup 和 Material Design Kit 开始,然后查看 CONTRIBUTING.md、mkdocs.yml 以及 /docs/components/sass/components 中的现有文件。将 /docs/snackbar.md 和 /docs/components/sass/components/_snackbar.scss 作为预期的入口点,并在实现前检查变量文件和 JavaScript 指南。组件页面、样式、所需的 token 和状态、代码链接以及与 Figma 的连接均完成文档记录并在 PR 中提交后,即可视为完成。
由索引模型根据 Issue 内容生成。
描述
Dependencies
#464
Overview
We need to create Design System Snackbar 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
snackbar - 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/_snackbar.scss
- below the HTML tab it would say HTML: https://github.com/hackforla/internship-website-design-system/blob/main/docs/snackbar.md
- 1.11 Connect component in Figma to GitHub Files
- 1.12 Original Design Issue: #464
- 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: [snackbar.md] - link the name to the file in the repo
- 2.02 SASS file(s) created: [snackbar.scss] - link the name to the file in the repo
- 2.03 link to Header Microsite page on live site: [Snackbar] (Replace with - link to the live URL If the site is live when this issue is worked on.
- 主要语言
- CSS
- 星标
- 20
- 派生
- 6
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
hackforla/internship 的其他 Issue
-
documentation help wanted question
难度 1/5 1 小时以内 新手友好度 90/100
hackforla/internship#835 ·
-
TWE Design System: Create Microsite Documentation Standards and Contributor Guidelines可能重新可做 @revforyou 于 144 天前认领,目前没有进行中的 PR。 未关闭complexity: small feature: design system role: engineering size: 1pt
hackforla/internship#831 · 已指派 1 人 ·
-
TWE: Dev: Design System: Update Toggle with Tokens可能重新可做 @zvidmarb 于 165 天前认领,目前没有进行中的 PR。 未关闭complexity: small feature: design system Participant Type: TWE Team Member role: engineering size: 1pt
hackforla/internship#830 · 已指派 1 人 ·
-
complexity: medium feature: design system Participant Type: TWE Team Member role: engineering size: 2pt
难度 4/5 3-5 天 新手友好度 52/100
hackforla/internship#829 ·
-
complexity: medium feature: design system Participant Type: TWE Team Member role: engineering size: 2pt
难度 4/5 3-5 天 新手友好度 55/100
hackforla/internship#828 ·
查看 hackforla/internship 的全部 Issue
相似的 Issue
-
npmx
难度 1/5 1 小时以内 新手友好度 86/100
catppuccin/userstyles#2363 ·
维护者通常 1 天内回复
-
enhancement good first issue
难度 1/5 1-3 小时 新手友好度 85/100
g0v/civic-talk-hono#202 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 64/100
MomsBloomOrg/momsbloom-resources#66 ·
维护者通常 1 天内回复
-
area:frontend priority:P2 type:feature
难度 2/5 1-3 小时 新手友好度 66/100
tecnologiasantos/bogoboom#70 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 67/100