-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# EveEveプロジェクトへの貢献ガイド | ||
|
||
EveEveプロジェクトへの関心をお寄せいただき、ありがとうございます!私たちは、あらゆる形の貢献を歓迎しています。このガイドは、プロジェクトへの貢献方法を説明します。 | ||
|
||
## 貢献の種類 | ||
|
||
以下のような様々な形で貢献できます: | ||
|
||
1. コードの改善や新機能の追加 | ||
2. バグの報告や修正 | ||
3. ドキュメントの改善や翻訳 | ||
4. デザインの改善 | ||
5. アイデアの提案 | ||
|
||
## 貢献のプロセス | ||
|
||
1. プロジェクトをフォークし、ローカルにクローンします。 | ||
2. 新しいブランチを作成します(`git checkout -b feature/amazing-feature`)。 | ||
3. 変更を加え、コミットします(`git commit -m 'Add some amazing feature'`)。 | ||
4. ブランチをプッシュします(`git push origin feature/amazing-feature`)。 | ||
5. プルリクエストを作成します。 | ||
|
||
## コーディング規約 | ||
|
||
- コードは明確で読みやすくしてください。 | ||
- 適切なコメントを追加してください。 | ||
- 既存のコードスタイルに従ってください。 | ||
- cd web && bun run check でフォーマットを整えてください。 | ||
|
||
|
||
|
||
## 優先度の高い貢献分野 | ||
|
||
現在、以下の分野での貢献を特に歓迎しています: | ||
|
||
- PDF等、複数フォーマット入力対応の実装 | ||
- 文字サイズや色の変更機能の追加 | ||
|
||
## イシューの報告 | ||
|
||
バグを見つけた場合や新機能のアイデアがある場合は、GitHubのIssueを作成してください。その際、以下の情報を含めてください: | ||
|
||
- 問題の簡潔な説明 | ||
- 再現手順(バグの場合) | ||
- 期待される動作と実際の動作 | ||
- スクリーンショット(可能な場合) | ||
|
||
## プルリクエスト | ||
|
||
プルリクエストを送る際は、以下の点に注意してください: | ||
|
||
- 変更内容を明確に説明してください。 | ||
- 関連するイシューがある場合は、そのイシュー番号を記載してください。 | ||
- 大きな変更の場合は、事前にイシューで議論することをお勧めします。 | ||
|
||
## コミュニケーション | ||
|
||
質問や提案がある場合は、以下の方法でコミュニケーションを取ることができます: | ||
|
||
- GitHubのIssueを作成する | ||
- プロジェクトのDiscordに参加する:https://discord.gg/2JfhZdu9zW | ||
|
||
## ライセンス | ||
|
||
このプロジェクトはMITライセンスの下で公開されています。貢献することで、あなたの貢献物もこのライセンスの下で公開されることに同意したものとみなされます。 | ||
|
||
皆様の貢献を心よりお待ちしています。一緒に、世界中の人々に物語と知識への扉を開くビジョンを実現しましょう! |