まず初めに、プロジェクトへの貢献に興味を持っていただきありがとうございます！ ❤️
どんな形であれ、貢献は大歓迎ですし、とても感謝しています。貢献方法について詳しくは、目次 をご覧ください。貢献する前に、関連するセクションに目を通していただけると、メンテナーの作業がスムーズになり、コミュニティ全体にとって良い体験になります。🎉
Note
忙しくて貢献する時間が取れないけれど、プロジェクトを応援したい…という方も大丈夫です！ 以下のような形でもサポートできます。
- プロジェクトにスターを付ける
- SNS でシェアする
- Readme などでこのプロジェクトを紹介する
- ミートアップなどで友人や同僚に伝える
Note
まずは 公式ドキュメント をご確認ください。
質問する前に、既存の Issues を検索してみてください。該当するものがあれば、そのスレッドに質問を追加できます。また、インターネットで解決策を探してみるのもおすすめです。
それでも解決しない場合は、以下の方法で質問できます。
- 新しい Issue を作成する
- 問題の詳細や環境情報（Node.js、npm などのバージョン）をできるだけ詳しく記載する
ご提供いただいた質問にはできるだけ早く対応します！
バグを報告する前に、以下の点を確認してください。
- 最新バージョンを使用しているか？
- それは本当にバグか？（設定ミスや環境依存の問題ではないか）
- 既に同じ問題が報告されていないか？ → バグ一覧
- インターネット上で同じ問題が議論されていないか？
- 以下の情報を整理する
- エラーメッセージやスタックトレース
- OS、環境、バージョン（Windows/Linux/macOS, x86/ARM など）
- 再現手順
Important
セキュリティに関わるバグは Issue ではなく、セキュリティポリシーに書かれている方法でご連絡ください。
バグを報告するには、新しい Issue を作成し、以下の点を含めてください。
- 期待される動作 と 実際の動作
- 再現手順（コード例があると助かります）
- 環境情報（OS・バージョン・使用ツールなど）
報告後の流れ：
- メンテナーがラベルを付けます。
- 再現手順が不十分な場合は、
needs-reproラベルが付きます（追加情報が必要です）。 - 再現できたら
needs-fixとなり、修正が進められます。
新機能や改善の提案をする場合、以下を確認してください。
- 最新バージョンを使用しているか？
- ドキュメントを読んで既に実装されていないか？
- 同じ提案が既に出ていないか？ → Issues
- この機能が多くのユーザーにとって有益か？
新しい Issue を作成し、以下の情報を含めてください。
- わかりやすいタイトル
- 現在の動作と期待する動作の違い
- なぜこの機能が必要か？
- 関連するスクリーンショットや参考情報（あれば）
私たちは、Next.jsを動作させるために、bunを用いています。 まずは、bunをインストールしてください。
Note
DBやGoogleAuthに関する情報はまだ執筆途中です。 もうしばらくお待ちください。
依存関係のインストールには、bun installを実行してください。
テストする方法として、bun devがもっとも簡単な方法です。
実環境と同じように動作させるには、bun run build && bun startを実行してください。
Note
ドキュメントに関してはこのリポジトリではない別のリポジトリで動作しています。 詳しくは、yuito-it/Linkle-Documentをご覧ください。
.prettierrc.yamlがプロジェクトに内包されていますので、それを基準に整形してください。
コミットメッセージは、以下の要件をなるべく満たしてください。
- タイトルは何をしたかを書いてください。
- 必要に応じて、絵文字もしくはプレフィクス(fix:やrefactor:、typo:、style: などが挙げられます)を使ってください。
- その下には、改行して、なぜその変更をしたのかを記述するようにしてください。
タグは、セマンティック バージョニング 2.0.0を採用しており、npm versionコマンドで管理しています。
基本的には、メンテナーがタグを打ちます。
学園生であれば、#tiems_linkleなどでお知らせください。
このガイドは contributing.md を参考に作成しました。