オープンソースコードを投稿する前に必要なこと

オープンソースプロジェクトの投稿は、インターネット上でのコードの投稿以上のものです。



過去10年間、オープンソースソフトウェアへの関心が高まっています。 Linuxは洗濯機とバトルドローンに属しています。 ほとんどのプログラマーは、自由でオープンソースの幅広いツールがなければ自分の人生を想像することはできません。



この注目すべき傾向の裏側は、新しいオープンソースプロジェクトをリリースするとき、あなたは激しい競争のゾーンにいるということです。



プロジェクトが注目されるのをどのように支援できますか？






コードを開く前に、この記事に記載されている質問に答えます。 ただし、必ずしも同じ順序ではありません。



チェックリストのすべてのポイントをたどることができますが、その一部しかできません。 目標を覚えておいてください-他の人があなたのプロジェクトについて学び、それをどのように使用するかを素早く理解し、それに参加するのを助けるため

免許

• プロジェクトにはライセンスがありますか？

ライセンスがなければ、プロジェクトはオープンソースソフトウェアではありません。 詳細についてはこちらをご覧ください 。

• このライセンスはOSI / FSFによって承認されていますか？

一部のライセンスは、オープンソースソフトウェアのライセンスに適しているように見える場合があります。 しかし、彼らにはそのような権利はありません。 OSIおよびFSFによって承認されたライセンスのリストを確認してください。

• ライセンスはエコシステム内の他のライセンスと互換性がありますか？

同様のトピックのライセンスプロジェクトを確認してください。 ライセンスの互換性の詳細については、 こちらをご覧ください 。

サイト

• プロジェクトにインターネット上のページがありますか？

GihubのReadme 、SourgeForceまたは専門サイトの プロファイル 。 あなたのプロジェクトは、インターネット上でその場所を持つ必要があります。

• ページの訪問者はすぐにそれが何であるかを理解しますか？

• そして、それはどのように機能しますか？

• 視覚要素を使用しましたか？

スクリーンショットと図は、読者の注意を引く簡単な方法です。

• 連絡先から離れましたか？

きっとあなたはあなたのプロジェクトに興味がある人々の考えを聞きたくなるでしょう。

在庫状況

• プログラミング言語にネイティブを配布する方法を提供していますか？

npm 、 gemまたはcrateのいずれかです。 言語にパッケージ管理システムがある場合、プロジェクトをその言語に登録する必要があります。

• * nixディストリビューションの配布方法を提案できますか？

使い慣れたソースからソフトウェアをインストールする機能は、ユーザーの快適さの一番上にあります。 時間がある場合は、 Fedora 、 Debian / Ubuntu、またはHomebrewのプロジェクトを必ずホストしてください。

• 自動インストーラーを作成するのは理にかなっていますか？

自動インストーラを使用すると、通常のツールを使用してパッケージをインストールするのと同じくらい簡単にプロジェクトを起動してインストールできます。 パッケージを作成してもプロジェクトに意味がない場合は、簡単なインストーラー/インストーラーを作成します（ このような、またはこのような）

ドキュメント

• ドキュメントはクイックインストールガイドから始まりますか？

プロジェクトのインストールと実行が簡単であればあるほど、誰かがそれを試す可能性が高くなります。

• インターフェイス/ APIリンクは有効になっていますか？

さらに、プロジェクトを「試す」機会を与えるために、誰かが本当にあなたの製品を使いたい場合、インターフェース/ APIリンクは非常に重要です。

• 一般的なドキュメントを見つけることができますか？

検索機能により、ドキュメントがより便利になります。 これがブラウザのctrl-fで1ページしかない場合でも。

• 開発者向けの環境を作成する方法を説明する必要がありますか？

おそらく、開発に参加したい人のためにプロジェクトをビルドしてデバッグする方法について言及したいと思うでしょう。

バグトラッカー

• 彼は空じゃないの？

現時点でバグを発見していない場合でも、改善したいことや次回行うことについてチケットを作成してください。 あなたは誰がそれらを見つけることができるかを決して推測しません。

• 初心者向けのいくつかのタスクが含まれていますか？

オープンソースプロジェクト向けのプログラミングを始めたばかりの人々を引き付けるために、いくつかの本当に簡単なタスクを実行してください。 関数を2つに分割したり、追加のコマンドライン引数を取得したりすることは、プロジェクトコードに慣れていない人にとっては素晴らしいタスクです。

• すべてのタスクは十分に説明されていますか？

すべてのタスクが十分に説明されていることを確認し、他のプログラマーが興味を持っている場合は簡単に作業できるようにします。

ツール

• プロジェクトに自動テストがありますか？

一連のテストにより、プロジェクトに参加するプログラマーの残りのプロジェクトコードとの互換性の変更を確認しやすくなります。



はじめに、注意、リリース！



肯定ですべての質問に答えれば、あなたのプロジェクトは他のオープンソースプロジェクトの中で非常に成功するでしょう。 すべてを行うことができない場合でも心配しないでください-小さなステップでもうまくいきます。



そして、最初の開発者が来てコードに何かを書くとき、これをBig Lebowskiからの男として言及することを忘れないでください：





イリノイ州からの新鮮な



このリストに他に何を追加できるかがわかっている場合は、記事またはTwitterで記事の作成者@radekpazderaにコメントを書き込んでください。