[generics-rep] Add expanded documentation

オープン
#240 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

Read the library guidelines documentation section and the two referenced commits from documentation PR 338 to identify the proposed guides for generics-rep. Then check how core libraries structure expanded documentation and whether the referenced content is still suitable; done means adding the agreed guides in that structure. The issue has no comments or linked pull requests, so check whether the proposal is still current before starting.

索引モデルが issue の本文から書いたものです。

説明

type: documentation

The purescript-contrib library guidelines suggest an expanded documentation directory. If we follow that same structure for the core libs (like generics-rep), then I'd like to add these guides on how to derive from generic:
https://github.com/purescript/documentation/pull/338/commits/9409b9a047aaa176199053928177c92739566a72
https://github.com/purescript/documentation/pull/338/commits/bb30b1514c406ee24eb6796d86ba282de323c4b7

That content was originally proposed for the language reference in https://github.com/purescript/documentation/pull/338

主要言語
PureScript
スター
168
フォーク
90
平均マージ
3日 1時間
マージ済み PR(30日)
1

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

purescript/purescript-prelude のほかの issue

purescript/purescript-prelude の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。