file-funeralプロジェクトへのコントリビューションを歓迎します!このガイドでは、プロジェクトに貢献するための手順とガイドラインを説明します。
私たちは、オープンで歓迎的なコミュニティを作ることを約束します。すべての参加者に対して、性別、性的指向、障害、外見、体型、人種、年齢、宗教、技術的な選択に関係なく、ハラスメントのない環境を提供します。
- 他者への思いやりと尊重
- 建設的なフィードバック
- コミュニティの利益を最優先
- 初心者への寛容さと助け合い
- ハラスメント、侮辱的なコメント
- トローリング、個人攻撃
- 公的または私的なハラスメント
- 他者のプライベート情報の無断公開
以下のような貢献を歓迎します:
- バグ修正: バグレポート、修正のプルリクエスト
- 新機能: 新しい機能の提案、実装
- ドキュメント: ドキュメントの改善、翻訳
- テスト: テストカバレッジの向上
- コードレビュー: 他の人のプルリクエストのレビュー
- デザイン: UIの改善提案
- パフォーマンス: パフォーマンス改善
初めての貢献を探している場合は、以下のラベルが付いたIssueを探してください:
good first issue: 初心者向けの簡単な問題help wanted: コミュニティからの助けを求めている問題documentation: ドキュメントの改善
- Rust: 1.92.0以降
- Node.js: 18以降
- Git: 2.x以降
- macOS: 11.0以降(開発環境として推奨)
-
リポジトリをフォーク:
- GitHubで
ohr486/file-funeralをフォーク
- GitHubで
-
クローン:
git clone https://github.com/YOUR_USERNAME/file-funeral.git cd file-funeral -
upstream リモートを追加:
git remote add upstream https://github.com/ohr486/file-funeral.git
-
依存関係をインストール:
npm install
-
開発サーバーを起動:
npm run tauri:dev
-
テストを実行:
npm test -
Lintを実行:
npm run lint
main: 本番リリース用(安定版)develop: 開発中の機能(デフォルトブランチ)feature/*: 新機能の開発fix/*: バグ修正docs/*: ドキュメント改善
-
最新のdevelopブランチを取得:
git checkout develop git pull upstream develop
-
機能ブランチを作成:
# 新機能の場合 git checkout -b feature/add-google-cloud-storage # バグ修正の場合 git checkout -b fix/s3-connection-timeout # ドキュメントの場合 git checkout -b docs/update-setup-guide
-
変更を加える:
- コードを書く
- テストを追加
- ドキュメントを更新
-
テストとLintを実行:
npm test npm run lint -
コミット:
git add . git commit -m "feat: add Google Cloud Storage support"
-
プッシュ:
git push origin feature/add-google-cloud-storage
-
プルリクエストを作成:
- GitHubでプルリクエストを作成
- ベースブランチ:
develop - 詳細な説明を記述
cargo fmtを使用してフォーマットcargo clippyの警告をすべて解決- 禁止:
unwrap()の使用(?またはexpect()を使用)
// ❌ 悪い例
let value = some_option.unwrap();
// ✅ 良い例
let value = some_option?;
// または
let value = some_option.expect("Expected value but got None");- 関数:
snake_case - 構造体:
PascalCase - 定数:
UPPER_SNAKE_CASE - モジュール:
snake_case
// ✅ 良い例
const MAX_FILE_SIZE: u64 = 5_000_000_000;
struct FileInfo {
pub path: String,
}
fn calculate_md5_hash(path: &Path) -> Result<String> {
// ...
}パブリックAPIには必ずドキュメントコメントを付ける:
/// ファイルをS3にアップロードする
///
/// # Arguments
/// * `path` - S3のキー(パス)
/// * `data` - アップロードするデータ
/// * `metadata` - ファイルメタデータ
///
/// # Returns
/// 成功時は `Ok(())`、失敗時は `StorageError`
///
/// # Examples
/// ```
/// let provider = S3Provider::new("my-bucket".to_string());
/// provider.upload("file.txt", b"content", metadata).await?;
/// ```
pub async fn upload(&self, path: &str, data: &[u8], metadata: FileMetadata)
-> Result<(), StorageError> {
// ...
}anyhow::Resultを内部実装に使用thiserrorを使用してカスタムエラー型を定義- エラーメッセージは具体的かつ actionable に
#[derive(Debug, thiserror::Error)]
pub enum StorageError {
#[error("File too large: {0} bytes (max {1} bytes)")]
FileTooLarge(u64, u64),
#[error("Network error: {0}")]
NetworkError(String),
}- ESLintの設定に従う
- Prettier でフォーマット(自動)
- コンポーネント:
PascalCase - 関数:
camelCase - 定数:
UPPER_SNAKE_CASE - 型/インターフェース:
PascalCase
// ✅ 良い例
const MAX_RETRY_COUNT = 3;
interface FileInfo {
path: string;
size: number;
}
function calculateProgress(current: number, total: number): number {
return (current / total) * 100;
}
export function FileList({ files }: { files: FileInfo[] }) {
// ...
}- 機能ごとにカスタムフックを作成
useプレフィックスを付ける
function useSyncStatus(localPath: string, remotePrefix: string) {
const [status, setStatus] = useState<SyncStatusResponse | null>(null);
const [loading, setLoading] = useState(false);
useEffect(() => {
// ...
}, [localPath, remotePrefix]);
return { status, loading };
}Conventional Commits 形式を使用:
<type>(<scope>): <subject>
<body>
<footer>
feat: 新機能fix: バグ修正docs: ドキュメントのみの変更style: コードの意味に影響しない変更(空白、フォーマットなど)refactor: バグ修正も機能追加もしないコード変更test: テストの追加・修正chore: ビルドプロセスやツールの変更
feat(storage): add Google Cloud Storage support
- Implement GCSProvider trait
- Add authentication flow for GCS
- Update documentation
Closes #42
fix(sync): handle network timeout correctly
Previously, network timeouts were not retried. Now we use
exponential backoff to retry failed requests.
Fixes #123
各モジュールに #[cfg(test)] mod tests を追加:
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_file_info_creation() {
let now = Utc::now();
let file = FileInfo::new("test.txt".to_string(), 100, now, None);
assert_eq!(file.path, "test.txt");
assert_eq!(file.size, 100);
}
#[tokio::test]
async fn test_s3_upload() {
// テストの実装
}
}tests/ ディレクトリに配置:
// tests/sync_integration_test.rs
use file_funeral::sync;
#[tokio::test]
async fn test_full_sync_workflow() {
// テストの実装
}Vitest を使用:
import { describe, it, expect } from 'vitest';
import { render, screen } from '@testing-library/react';
import { FileList } from './FileList';
describe('FileList', () => {
it('renders file list correctly', () => {
const files = [
{ path: 'test.txt', size: 100, last_modified: '2024-01-01', etag: null }
];
render(<FileList files={files} />);
expect(screen.getByText('test.txt')).toBeInTheDocument();
});
});# すべてのテストを実行
npm test
# Rustテストのみ
npm run test:rust
# TypeScriptテストのみ
npm run test:frontend
# 詳細出力
npm run test:rust:verbose-
npm testがパスする -
npm run lintがパスする - 新機能にはテストを追加
- ドキュメントを更新(該当する場合)
- コミットメッセージがConventional Commits形式
- 変更内容を
CHANGELOG.mdに追加(メンテナーが行う場合もあり)
## 概要
この変更の目的を簡潔に説明してください。
## 変更内容
- 追加した機能/修正したバグ
- 影響を受けるコンポーネント
## テスト
- [ ] ユニットテストを追加
- [ ] 統合テストを追加
- [ ] 手動でテスト済み
## スクリーンショット(UI変更の場合)
変更前と変更後のスクリーンショットを添付してください。
## 関連Issue
Closes #123- プルリクエストを作成
- CI(自動テスト)がパスするのを待つ
- メンテナーがレビュー
- フィードバックに対応
- 承認後、マージ
以下の情報を含めてください:
## バグの説明
何が起こったか、何が期待されるかを説明してください。
## 再現手順
1. '...'に移動
2. '...'をクリック
3. '...'を入力
4. エラーが表示される
## 期待される動作
何が起こるべきかを説明してください。
## 環境
- OS: macOS 14.2
- Rustバージョン: `rustc --version`
- Node.jsバージョン: `node --version`
- アプリバージョン: v1.0.0
## ログ/エラーメッセージエラーログをここに貼り付け
## スクリーンショット
該当する場合は添付してください。
## 機能の説明
提案する機能を説明してください。
## 動機
なぜこの機能が必要なのかを説明してください。
## 代替案
検討した代替案があれば説明してください。
## 追加のコンテキスト
その他の情報やスクリーンショットを追加してください。- README.md: プロジェクト概要
- SETUP_GUIDE.md: セットアップ手順
- TROUBLESHOOTING.md: トラブルシューティング
- ARCHITECTURE.md: アーキテクチャ説明
- API_REFERENCE.md: API ドキュメント
- CONTRIBUTING.md: このファイル
- 明確で簡潔な文章
- コード例を含める
- スクリーンショットを追加(UI関連)
- 最新の状態を保つ
Semantic Versioning を使用:
- Major (x.0.0): 互換性のない変更
- Minor (1.x.0): 後方互換性のある新機能
- Patch (1.0.x): 後方互換性のあるバグ修正
-
developブランチでバージョンを更新:# package.json "version": "1.1.0" # src-tauri/Cargo.toml version = "1.1.0"
-
CHANGELOG.mdを更新 -
develop→mainにマージ -
タグを作成:
git tag -a v1.1.0 -m "Release v1.1.0" git push origin v1.1.0 -
GitHub Releasesでリリースノートを公開
質問や不明点がある場合は:
- GitHub Discussions で質問
- GitHub Issues でバグ報告
- README.md でプロジェクト概要を確認
コントリビューションすることで、あなたの貢献がプロジェクトのライセンス(MITライセンス)の下でライセンスされることに同意したことになります。
ご協力ありがとうございます!🙏