issue233-docs-update - Githubissues

YungTatyu commented 4 months ago

クラス図をupdateしてwikiで共有するようにしますか？ Sheid.ioはなんのバッジをつけたらいいかわからなかったです。（cppくらい？）

ayase-mstk commented 4 months ago

クラス図をupdateしてwikiで共有するようにしますか？

それもいいですね！

Sheid.ioはなんのバッジをつけたらいいかわからなかったです。（cppくらい？）

dockerとかgithub actionsとかpythonやshellもテストで使っているので追加してもいいんじゃないでしょうか！

ごめんなさいリンク張れてなかったです。。 https://qiita.com/shun198/items/c983c713452c041ef787 使い方はここにあります。 https://shields.io/badges/static-badge

例ですが、こんな感じです。

<!-- シールド一覧 -->
<!-- 該当するプロジェクトの中から任意のものを選ぶ-->
<p style="display: inline">
  <!-- ソースコードで使われている技術 -->
  <img src="https://img.shields.io/badge/-C++-00599C.svg?logo=c%2B%2B&style=for-the-badge">
  <!-- テストで使われている技術 -->
 <img src="https://img.shields.io/badge/-Python-F9DC3E.svg?logo=python&style=for-the-badge">
  <img src="https://img.shields.io/badge/-Shell_Script-red.svg?logo=Shell&style=for-the-badge">
  <img src="https://img.shields.io/badge/-Docker-EEE.svg?logo=docker&style=for-the-badge">
  <img src="https://img.shields.io/badge/-githubactions-black.svg?logo=github-actions&style=for-the-badge">
</p>

YungTatyu commented 4 months ago

Sheid.ioのバッジについて他のrepを参考にしましたけど、そんなにプログラミング言語をのせてる感じではなさそうです。（それはどちらかというと自分のプロフィールでアピールするために使ってそう）。はやせさんがイメージしているrepなどがあれば共有してほしいです。

ayase-mstk commented 4 months ago

どこかのrepを参考にしたというよりは、先ほど送らせていただいたリンクでみて、一目でどの技術が使われているかわかっていいなというくらいで提案させていただきました。慣用的に使われていなさそうであれば、採用しなくても大丈夫です！

YungTatyu commented 4 months ago

開発者向けのdocumentを作りますか？例えば、nginxのようなopen sourceのプロジェクトにはそのような開発者（貢献してくれる人）へのドキュメントがあります。いろいろな人が開発に携わる前提ならそのような、documentが必要だと思います。テストなどについては、userは使用しないので、readmeには不要だと思います。

ayase-mstk commented 4 months ago

ReadMeには書かなくていいと思います！Wikiなどに書くのがいいと思います！もしかしたらforkして機能追加とかする可能性もあるのであると嬉しいかもです！

YungTatyu commented 4 months ago

そうですね、なにを対応してなにを対応しないか整理したいと思います。

YungTatyu / webserv

issue233-docs-update #256