ft_irc Documentation

Appearance

貢献ガイドライン ​

ft_irc プロジェクトへの貢献を歓迎します。このガイドラインは、コードベースへの貢献をスムーズに行うための情報を提供します。

1. コミットメッセージ規約 ​

本プロジェクトでは、Conventional Commits の仕様に準拠したコミットメッセージを推奨しています。これにより、変更の意図が明確になり、リリースノートの自動生成やプロジェクト履歴の可読性が向上します。

コミットメッセージの書式:

<type>(<scope>): <subject>

<body>

<footer>
  • <type>: 変更のタイプ (例: feat, fix, docs, refactor, test, build, ci, perf)
  • <scope> (オプション): 変更が影響する範囲 (例: server, client, channel, docs, Makefile)
  • <subject>: 変更の簡潔な説明 (50文字以内)
  • <body> (オプション): 変更の詳細な説明 (各行72文字以内)
  • <footer> (オプション): 関連するIssue番号など

例:

feat(server): Implement new NICK command validation

This commit introduces comprehensive validation for the NICK command,
ensuring that nicknames adhere to IRC protocol specifications.
Checks include length limits, allowed characters, and uniqueness
across connected clients.

Fixes #123

2. プルリクエスト (PR) プロセス ​

  1. ブランチの作成: 常に main ブランチから新しいフィーチャーブランチを作成してください。ブランチ名は変更内容を反映したものにしてください (例: feat/add-new-command, fix/bug-in-parsing).
  2. コーディング: 変更を行い、必ずコーディング規約に従ってください。
  3. テスト: 変更がすべてのテストをパスすることを確認してください (make test)。新しい機能を追加した場合は、対応するテストも追加してください。
  4. コミット: Conventional Commits に従ってコミットメッセージを記述し、変更をコミットしてください。
  5. プッシュ: 作成したブランチをリモートリポジトリにプッシュしてください。
  6. プルリクエストの作成: GitHub上でプルリクエストを作成してください。プルリクエストのDescriptionには、以下の情報を含めることを推奨します。
    • 変更の概要
    • 変更の理由（解決する問題、追加する機能）
    • どのようにテストしたか
    • 関連するIssue番号
  7. レビュー: チームメンバーからのレビューを受け、必要に応じて変更を加えてください。

関連リンク: