Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #47

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Improve README #47

wants to merge 1 commit into from

Conversation

n4o847
Copy link
Owner

@n4o847 n4o847 commented Dec 18, 2020

解決する Issue

改善内容

各自参加記を書いたりするにあたってこのリポジトリを引用することもあるかと思うので、README をしっかりしたものに書き換えます。(もう遅かったらごめんなさい……)

基本的に #35 の体裁を整えたのと、序文は #44 をもとにしています。

発表資料の部分には発表スライドへのリンク付きサムネイルを貼ります。

@yapatta
Copy link
Collaborator

yapatta commented Dec 18, 2020

そういえばnodeとnpmのどのバージョンで動くか書いときたいですね
因みに僕はnodeがv12.19.0、npmが6.14.8でした

Comment on lines +8 to +10
セキュリティ・キャンプについては[こちら](https://www.ipa.go.jp/jinzai/camp/)
セキュリティ・キャンプ全国大会2020 オンラインについては[こちら](https://www.ipa.go.jp/jinzai/camp/2020/zenkoku2020_index.html)
講義「ReDoSの検出プログラムの作成とOSSへの適用」については[こちら](https://www.ipa.go.jp/jinzai/camp/2020/zenkoku2020_program_list.html#list_s-z3)
Copy link
Collaborator

Choose a reason for hiding this comment

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

末尾に空白を入れて改行するようにしてるみたいですが、このようにしたいのであれば素直にリストを使った方が良いと思います。

Comment on lines +61 to +63
## 動作に必要なもの

- npm
Copy link
Collaborator

Choose a reason for hiding this comment

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

これが末尾あるのは違和感があります。あまり重要でもないので削除するか、そうでなければ「使い方」の先頭に持っていった方がいいと思います

@n4o847
Copy link
Owner Author

n4o847 commented Dec 19, 2020

動作に必要なもの (requirements) は個人的には要らない気がするのですがどうでしょう?

node や npm のバージョンに関する記述はしないことが多いように思う(これは他の人が言っていたことの受け売りなんですが、Node.js は後方互換性に優れているためユーザが latest を使わない意義が無いため)

……のですが、今試してみたら Node.js 10 系では Array.prototype.flatMap が無くてコケるんですね。

10 系はサポート期間が 2021-04-01 までらしいので一応 12 系以上が対象であることは書いておくべきか……。

@masa5555
Copy link
Collaborator

自分が最初に、「動作に必要なもの npm」を特に深い意味はなく書いてしまったので消してもらっても大丈夫です。

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.

4 participants