Skip to content

docs: コントリビューター向けのドキュメントファイルの追加#33

Open
D-ske104 wants to merge 11 commits into
ShuntaToda:mainfrom
D-ske104:feature/add-contribution-files
Open

docs: コントリビューター向けのドキュメントファイルの追加#33
D-ske104 wants to merge 11 commits into
ShuntaToda:mainfrom
D-ske104:feature/add-contribution-files

Conversation

@D-ske104
Copy link
Copy Markdown

@D-ske104 D-ske104 commented Jul 25, 2025

@ShuntaToda
いつも機能追加やメンテナンスしていただきありがとうございます!

動機

#23 (comment) でのコントリビューターとのやり取りを拝見し、PullRequestで正常性チェックができたり、Issue, PullRequestのテンプレートがあればオーナーとコントリビューターと双方の負担軽減になるかと考え、以下の変更を提案いたします。

このPRのコードに対してのコメント

コントリビュートの際の注意点などを記載していない私が悪いのですが、以下の点が気になりました

ESLintのエラーが出ている点

以下のコマンドを実行していただくとESLintのエラー箇所がわかります。

npm run lint

または、こちらのVSCodeの拡張機能をご利用いただくことで確認できます。

oclifのデフォルトで指定されているESLintのルールを利用しているので、かなり細かいですが、よろしくお願いいたします。

変更内容

GitHub貢献者向けリソースの包括的な追加と改善を実施しました:

📋 テンプレート・設定ファイル

  • Pull Requestテンプレート (.github/PULL_REQUEST_TEMPLATE.md) - 統一されたPRフォーマットを提供
  • Issueテンプレート (.github/ISSUE_TEMPLATE/) - バグ報告、機能要求、設定ファイルを追加
  • PR自動チェックワークフロー (.github/workflows/pr-checks.yml) - Pull Request作成・更新時の自動検証

📚 ドキュメント

  • 貢献ガイドライン (docs/CONTRIBUTING.md) - プロジェクトへの貢献方法を詳細に説明
  • README.md - リスト記法を *- に統一しました

変更理由

プロジェクトへの貢献をより効率的かつ一貫性のあるものにするため:

  1. 貢献プロセスの標準化 - 新規貢献者が迷わずに参加できる環境を整備
  2. 品質保証の自動化 - PR作成時の自動チェックにより、コード品質を維持
  3. Issue管理の効率化 - 構造化されたテンプレートにより、問題報告の質を向上
  4. 開発体験の向上 - 明確なガイドラインにより、開発者の生産性を向上

テスト方法

以下のコマンドでワークフローとテンプレートの動作を確認:

# Lintチェック
npm run lint

# フォーマットチェック  
npm run format

# テスト実行
npm test

# GitHub Actionsワークフローの構文チェック
gh workflow list

スクリーンショット(必要な場合)

PullRequestテンプレートやIssueテンプレートはフォークした私のリポジトリで動作確認可能です。

Issue
https://github.com/D-ske104/backlog-exporter/issues

Pull Request
D-ske104#1

Issueテンプレート

Issueテンプレート フォーム選択

Issueテンプレート 機能追加

Issueテンプレート バグ報告

PullRequest テンプレート

PullRequestテンプレート

PullRequest 正常性チェック GitHubActions

PullRequest 正常性チェックGitHubActions

関連Issue

#23

チェックリスト

  • テストが通ることを確認しました
  • Lintエラーがないことを確認しました (npm run lint)
  • コードスタイルが一貫していることを確認しました (npm run format)
  • 関連するドキュメントを更新しました
  • GitHub Actionsワークフローが正常に動作することを確認しました
  • Issueテンプレートが適切に表示されることを確認しました
  • Pull Requestテンプレートが適切に表示されることを確認しました

補足

プロジェクトへの行動規範 CODE_OF_CONDUCT.md は提案に含めておりませんが、ぜひ今後ご検討ください。

https://docs.github.com/ja/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project

@ShuntaToda ShuntaToda self-requested a review July 28, 2025 01:14
Copy link
Copy Markdown
Owner

@ShuntaToda ShuntaToda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

すごく丁寧に作成ありがとうございます!
内容問題ないと判断いたしました。
LGTMです!

@ShuntaToda ShuntaToda self-requested a review July 28, 2025 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants