読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
オープンソースプロジェクトで上手いことやってくための10の方法 - Qiita
何も考えずに書き始めたけど10の方法って書いちゃった。 いくつになるかはわかりません。 一般的なプロジェクト運用でもある程度同じ方法論でイケると思います。 なお、筆者であるvvakameはDefinitelyTypedのメンテナをしています。 そのため、これから先の文章について、TypeScriptやJavaScript関係固有の事象が含まれていると思います。 書かれている内容について、contributeする側、される側、両側へのアドバイスを書きます。 ちなみに、わかめ的にはTOMOYO Linuxに学ぶ説得術とかはすごい参考になりました。 こまけぇことはいいんだよ！まずはやろう！ 貴方が世界に存在するためにはまず誰かに存在を知ってもらわなければいけません。 pull requestを出そう！無理だったらIssueを書こう！ まずはそこからだ！！ pull requestのmergeを拒
インフラの継続的デリバリー - naoyaのはてなダイアリー
事前に断っておくがここでいう「インフラ」はレイヤ的には OS より上の話。 少し前に GitHub 時代のデプロイ戦略 - naoyaのはてなダイアリー で、GitHub を介したデプロイを実践しているということを紹介した。普段の開発を Pull Request ベースでやっているので、デプロイもまた Pull Request を契機に実行させると色々捗る、という話。 このプラクティスの対象領域をインフラにまで拡大してみました、というのが今回の話。 DNS レコードを Pull Request を merge した契機に自動で更新 AWS を利用している場合、ドメインの管理も Amazon Route 53 を使うといろいろと都合がいい。 Route 53 での DNS レコードの更新はこれまでブラウザから操作していた。これだと誰がいつ作業したかわからないし履歴もトラックしづらい。また変更
Confluence
{"serverDuration": 17, "requestCorrelationId": "f12953c41087422ba55291f4cd3ff3b9"}
Big Sky :: SSHポートが通らなくてもgithub.comにpushする方法
« ニコニコ動画をダウンロード出来るPerlモジュールWWW::NicoVideo::Downloadを試してみた。 | Main | ニコニコ動画をダウンロード出来るプログラムをC言語で作ってみた。 » 皆さん既に知ってたら御免なさい。ずっと知らなかったのでgithubには手を付けてませんでした。 githubは、cloneするとき # git clone git://github.com/yappo/konnitiwa.git の代わりに # git clone http://github.com/yappo/konnitiwa.git とgitをhttpにするとclone出来るのは知っていたのですが、pushはsshを使うのでport 22が開いてないとpush出来ない物と信じ込んでいました。 が、今日解決しました。以下私がWindowsで行った手順 Windowsじゃない人は最初の
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
MIT License
和文フリーフォントの最上位でしょ！グーグルとAdobeが作った「源の角ゴシック」をゲットすべし * prasm（プラズム）
会社に Github導入した話
GitHub - ovity/octotree: GitHub on steroids
レビューのススメ？
GitHub Preview