Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 6.12 KB

CONTRIBUTING.md

File metadata and controls

114 lines (78 loc) · 6.12 KB
Raw

Pull Requestガイド

紹介記事の追加

JSer.info Pull Request Form

JSer.info で紹介して欲しい記事やサイト等をPull Requestしたい場合は、 JSer.info Pull Request Form を利用すると、 追加するJSONフォーマットを自動的に生成できます。 (その月の data/<year>/<month>/index.json に対してJSONを追記していきます。)

Pull Requestを取り込むか(掲載するか)は個人的な判断にて決定するため、マージする保証はありませんが、 自己推薦や宣伝記事であっても興味深い内容だと判断されればマージされます。

明確な基準はありませんが、最低限意識する事として以下の通りです。

  • 嘘や誇張など誤解されやすい表現は避ける
  • 意味のある内容にする(長さは関係ない)
  • 客観的な説明文にする

説明文はPull Request後も変更できるのでとりあえずPull Requestを送ってみるといいです。

掲載のポリシー

JSer.infoでは以下のポリシーをもって掲載しています。

  • 嘘、誇張、不正確な内容は避ける
  • 主張だけ判断しないで中身を見て確認する

また、次のCODE_OF_CONDUCTを採用しています。

簡単にまとめると

  • コントリビューターには敬意を払います
  • プロジェクトに参加するすべての人に対してハラスメントがないように取り組みます
  • 差別的、攻撃的表現などを使いません
  • CODE_OF_CONDUCTに従っていない行動に対しては削除、編集、拒否の権利と責任があります

紹介記事の書き方

紹介記事データにはサイトタイトルやURL、タグといった項目がありますがどのようなものを入力すればいいかを簡単に解説します。

  • タイトル
    • 紹介したいサイトのタイトルを入力します。
    • <title> 要素に書かれているものをそのまま使うのが望ましいですが、空欄となってる場合や長すぎる場合は適当なものを入力して問題ありません。
  • URL
    • サイトのURLを入力します。
    • URLに utm_ 等トラッキング要素が入ってないか、パーマネントリンクとして正しいかなどをチェックしましょう。
  • 説明
    • サイトについての簡単な概要を入力します。
    • 行数の制限はありませんができるだけ簡潔に(全てを説明しなくてよい)。
    • Twitterに投稿できる140文字以下を目安にするといいかもしれません。
    • Markdownも利用できます。
    • その記事の要点やライブラリなら目的、機能など簡単に書くとよいと思います。
    • 事実をベースにし、考えは考えと分かるように書きます。
    • 文体としては「ですます調」より断定的な形(短く書くため)
    • 一行目に概要、二行目から内容の紹介というコミットメッセージ的な書き方が多いです。
    • 迷った場合は既存の記事を真似てみるとよいと思います。
  • タグ
    • サイトのタグを入力します。
    • JavaScript や library 等 関連しそうなキーワードのタグをカンマ区切りで入力します。
    • JSer.infoで使われてるタグは ブックマーク から見られますが、必ずしもコレに合わせなくても良いです。
  • 関連サイト
    • 紹介したいサイトに関係ありそうなサイトを入力します。
    • なければ省略しても問題ありません。
    • 合わせて読むといい記事や紹介してるライブラリのサイトなどを入れるといいかもしれません。

説明について

説明 はどう書けばいいか悩むかもしれませんが、とりあえずで書いてPull Requestで丸投げするのもひとつの手です。 またはPing! to JSer.infoで投げるのがよいでしょう。

掲載のポリシーでも述べたように、多少冗長であっても誤解されにくい表現にするといいかもしれません。

例えば、 軽いライブラリ という表現だと コード量的に軽いのか、速度が早いという意味なのかわからないので、 コード量的な意味なら ファイルサイズが小さなライブラリ とする方がいいでしょう。

説明は主張や宣伝文ではなく、客観的な事実をベースにした紹介文です。

スペルチェック

azu/technical-word-rulesの辞書を使った、 用語統一のLintがコミットに対してチェックが自動的に行われます。

チェック対象となった場合の対応

Lint結果に対して以下のような対応を取ることができます。

  1. コメントに応じて修正する
  2. azu/technical-word-rulesの辞書を修正する

辞書は完璧ではないので、辞書の方を直したほうが良い場合はコメントなどして下さい。

ローカルでLintする方法

npm install
npm test

Lintを実行することができます。

その他の修正や改善

gh-pages の方に修正内容や追加の実装などをPull Requestして下さい。

ライセンス

  • Pull Requestされたコードに対しては MITライセンス が適応されます。
  • Pull Requestされた記事の紹介文に対しては CC-BYライセンス が適応されます。