From b1b90185c462a1b9cda06e289360ec9be4c51e58 Mon Sep 17 00:00:00 2001 From: syuilo Date: Sat, 28 Aug 2021 15:29:40 +0900 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c0b1da68..4d1902502 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ # Contribution guide -**[✨ English version available](./docs/CONTRIBUTING.en.md)** +**[✨ English version available](/docs/CONTRIBUTING.en.md)** プロジェクトに興味を持っていただきありがとうございます！ このドキュメントでは、プロジェクトに貢献する際に必要な情報をまとめています。 @@ -16,7 +16,7 @@ PRを作成する前に、以下をご確認ください: - fix / refactor / feat / enhance / perf / chore 等 - また、PRの粒度が適切であることを確認してください。ひとつのPRに複数の種類の変更や関心を含めることは避けてください。 - このPRによって解決されるIssueがある場合は、そのIssueへの参照を本文内に含めてください。 -- [`CHANGELOG.md`](./CHANGELOG.md)に変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。 +- [`CHANGELOG.md`](/CHANGELOG.md)に変更点を追記してください。リファクタリングなど、利用者に影響を与えない変更についてはこの限りではありません。 - この変更により新たに作成、もしくは更新すべきドキュメントがないか確認してください。 - 機能追加やバグ修正をした場合は、可能であればテストケースを追加してください。 - テスト、Lintが通っていることを予め確認してください。 @@ -33,7 +33,7 @@ CI上でも自動でチェックされ、ルールに則っていないコード ### Jest このプロジェクトではテストフレームワークとして[Jest](https://jestjs.io/)を導入しています。 -テストは[`/test`ディレクトリ](./test)に置かれます。 +テストは[`/test`ディレクトリ](/test)に置かれます。 テストはCIにより各コミット/各PRに対して自動で実施されます。 ローカル環境でテストを実施するには、`npm run test`を実行してください。 @@ -41,14 +41,14 @@ CI上でも自動でチェックされ、ルールに則っていないコード ### tsd このプロジェクトでは型のテストを行うために[tsd](https://github.com/SamVerschueren/tsd)を導入しています。 Jestによるテストでは「型が期待したものか」というのはチェックすることができません。tsdを使うことで、型が意図したものであることを担保することができます。 -tsdによる型テストは[`/test-d`ディレクトリ](./test-d)に置かれます。 +tsdによる型テストは[`/test-d`ディレクトリ](/test-d)に置かれます。 テストはCIにより各コミット/各PRに対して自動で実施されます。 ローカル環境でテストを実施するには、`npm run test`を実行してください。 ### API Extractor このプロジェクトでは[API Extractor](https://api-extractor.com/)を導入しています。API ExtractorはAPIレポートを生成する役割を持ちます。 -APIレポートはいわばAPIのスナップショットで、このライブラリが外部に公開(export)している各種関数や型の定義が含まれています。`npm run api`コマンドを実行すると、その時点でのレポートが[`/etc`ディレクトリ](./etc)に生成されるようになっています。 +APIレポートはいわばAPIのスナップショットで、このライブラリが外部に公開(export)している各種関数や型の定義が含まれています。`npm run api`コマンドを実行すると、その時点でのレポートが[`/etc`ディレクトリ](/etc)に生成されるようになっています。 exportしているAPIに変更があると、当然生成されるレポートの内容も変わるので、例えばdevelopブランチで生成されたレポートとPRのブランチで生成されたレポートを比較することで、意図しない破壊的変更の検出や、破壊的変更の影響確認に用いることができます。 また、各コミットや各PRで実行されるCI内部では、都度APIレポートを生成して既存のレポートと差分が無いかチェックしています。もし差分があるとエラーになります。