TWE: Dev: Design System: Create Badges
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 55/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- css, html, markdown, sass
- 領域
- design, documentation, frontend
調査の方向性
まず Badges Microsite mockup、Material Design Kit、CONTRIBUTING.md を確認してください。次に mkdocs.yml、docs/badges.md、docs/components/sass/components/_badges.scss、既存の variables.scss ファイルを調べ、プロジェクトの規約に従ってください。ドキュメント化されたコンポーネントの状態とコード例がデザインと一致し、必要なリンクとトークンが含まれ、PR を作成する前にテンプレートのフロントエンドが確認されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Dependencies
#693
Overview
We need to create Design System Badges 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
badges - 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/_badges.scss
- below the HTML tab it would say HTML: https://github.com/hackforla/internship-website-design-system/blob/main/docs/badges.md
- 1.11 Connect component in Figma to GitHub Files
- 1.12 Original Design Issue: #693
- 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: [badges.md] - link the name to the file in the repo
- 2.02 SASS file(s) created: [badges.scss] - link the name to the file in the repo
- 2.03 link to Header Microsite page on live site: [Badges](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 ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
hackforla/internship のほかの issue
-
documentation help wanted question
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
hackforla/internship#835 ·
-
TWE: Research: Skills Issue: Onboard and Assess: Promise McEntire対応中かも @promise-mc が 27 日前に担当しました。 オープンfeature: onboarding feature: skills assessment good first issue Participant Type: TWE Team Member role: new team member role: UI/UX research size: 0.50pt
hackforla/internship#833 · コメント 28 件 · 担当者 1 名 ·
-
TWE Design System: Create Microsite Documentation Standards and Contributor Guidelines再び着手できるかも @revforyou が 119 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンcomplexity: small feature: design system role: engineering size: 1pt
hackforla/internship#831 · 担当者 1 名 ·
-
TWE: Dev: Design System: Update Toggle with Tokens再び着手できるかも @zvidmarb が 140 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン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 ·
hackforla/internship の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
daangn/seed-design#2482 ·
メンテナーはふだん 1 日以内に返信
-
16 slate buttons are unreadable in the light theme (dark text on dark grey)対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンbug needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
vavallee/bindery#3241 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
agent-ready Compliance Frontend priority: low UX
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
homarr-labs/dashboard-icons#2944 ·
メンテナーはふだん 1 日以内に返信