このドキュメントを別の言語で表示する： English / 简体中文 / Español / Português / 한국어
このプロジェクトに貢献したいですか?素晴らしい!
このプロジェクトはコントリビューター行動規範に準拠しています。参加する場合、あなたにはこの規範を守ることが求められます。許容できない行為の報告の詳細については行動規範をご覧ください。
はじめてのPull Requestに取り組んでいますか? GitHubでオープンソースプロジェクトに貢献する方法
-
プロジェクトのセットアップは? カバーしています!
-
バグを見つけましたか? お知らせください！
-
バグを修正しましたか? PRをつくってください！
-
新しい機能を追加しましたか? 必ず機能を説明するIssueを立ててください。フィードバックの準備ができたら、新しいPRを作成してください!
私たちはあなたがプロジェクトに貢献したいと思ってくれることを非常に嬉しく思います！ ❤️ 以下の手順を実行すると準備ができます:
- リポジトリをフォークし、クローンする
- 必要な依存関係をインストールする:
$ npm install
- 開発用サーバを起動する:
インタラクティブインターフェースで使用可能なすべてのコンポーネントを表示するには、storybookを使ってください$ npm run storybook
.
├── index.html: デモページ
├── style.css: デモページのスタイル
├── css: 配布用ファイル
├── docs: Storybookのストーリー
└── scss: ソースファイル
├── base
│ ├── reboot.scss: 変更しないで! (Bootstrap Reboot)
│ ├── generic.scss: 一般的なスタイルとreboot.cssの上書き
│ └── variables.scss: 共通変数
├── elements
├── components
├── form
├── icons: 16x16のアイコン
├── pixel-arts: 16x16以外のアイコン
└── utilitiesTip: あなたの
masterブランチは元のリポジトリを指すようにし、フォークしたブランチからPull Requestを作成します。これを行うには:git remote add upstream https://github.com/nostalgic-css/NES.css.git git fetch upstream git branch --set-upstream-to=upstream/master masterこれにより、元のリポジトリが"upstream"という名前の"remote"として追加されます。そのリモートからgitの情報を取得し、
git pullを実行する度にupstream/masterブランチを使用するように、masterブランチを設定します。この時点で、このmasterブランチからすべてのブランチを作成することができます。あなたのmasterのバージョンを更新したいときは、通常のgit pullを行います。
以下は、nostalgic-css Organizationのメンバーが従わなければならない手順です。外部のコラボレーターは、上記のガイドラインに従うだけです。
- 以下の書式ルールで
developからブランチを切る。 - Issue対応に必要な作業。Issueに関係のない問題がある場合は、新しいIssueを立てて別ブランチで作業してください。
developにマージするようPRを作成する- 現在の開発に影響を与えるような変更は、その説明を文書化する必要があります。
- PRのタイトルにIssue番号を含める必要があります。 IE:
[#33] Fix bug - 自分自身にPRをアサインします。
- PRがマージできるようになったら、レビューは
nostalgic-css/NES.cssチームから依頼する必要があります。
- PRが承認されたら、変更をマージするのはassigneeの仕事です。
プロジェクトへのすべてのコミットはCommitizenとcommitlintを使って読みやすいようにします。さらにリリースが自動化され、ロマンティックでなく、センチメンタルでもないことを保証するために[semantic-release]を使用します。