Skip to content

Conversation

@fsubal
Copy link
Member

@fsubal fsubal commented Mar 14, 2022

やったこと

ドキュメントサイトにコンテンツを加えた

  • カバーページの見た目を調整
  • トップページに使い方の案内を追加
  • 各ライブラリの説明として、とりあえず README.md の内容をそのままサイトに掲載

バージョニング


{+ 破壊的変更なし +} / {- 破壊的変更あり -}

  • 破壊的変更がある場合には、対象のパッケージのメジャーバージョンが上がっていることを確認した

チェックリスト

不要なチェック項目は消して構いません

  • 追加したコンポーネントが index.ts から再 export されている

yarn

```bash
yarn add -D @charcoal/icons
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

icons は devDependencies 推奨ではなさそう


```
npm i @charcoal/theme
npm i --save-dev @charcoal/theme
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

こっちも間違っていた

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


`@charcoal` is using [commintlint](https://github.com/conventional-changelog/commitlint) and
following the [Conventional Commits](https://www.conventionalcommits.org/ja/v1.0.0/) rules.
## charcoal のはじめ方
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

大文字小文字表記が揺れているのでルールがあったほうが良さそう

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

最初は大文字の気持ちでした。たしかにルール無さそう。

@fsubal fsubal requested a review from pnlybubbles March 14, 2022 05:42
# Charcoal

> Utility-first & layered design system
> Design system library by pixiv
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: ここのフレーズは後で変える

Comment on lines +5 to +7
- ユーティリティファーストな設計
- CSS-in-JS と CSS 両方で使える
- 既存のプロジェクトに導入がしやすい
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

キャッチフレーズ変更のタイミングでここを決めるので、今は一旦消す

Suggested change
- ユーティリティファーストな設計
- CSS-in-JS と CSS 両方で使える
- 既存のプロジェクトに導入がしやすい

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OKです!

Copy link
Contributor

@pnlybubbles pnlybubbles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTMです!

## charcoal という名前

## Setup
「charcoal(木炭)」とはデッサンの道具であり、線を引く、表現の基礎となる素材の一つです。また創作物を主役とするサービスの基盤として、それ自体は色を持たないモノクロの素材である、というニュアンスも含みます。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

めちゃよいですね。ここでコンセプトの説明がされていればリード文でコンセプトについて触れなくてもよいかもしれない。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants