docs: コントリビューター向けのドキュメントファイルの追加#33
Open
D-ske104 wants to merge 11 commits into
Open
Conversation
- CONTRIBUTING.md: Linter実行などについて言及 - DEVELOPMENT.md: 開発セットアップを文書化
下記プルリクエストのフォーマットを参考にしています ShuntaToda#29
- bug_report.yml - feature_request.yml 内容はownerの承認を得る必要があります
ShuntaToda
approved these changes
Jul 28, 2025
Owner
ShuntaToda
left a comment
There was a problem hiding this comment.
すごく丁寧に作成ありがとうございます!
内容問題ないと判断いたしました。
LGTMです!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@ShuntaToda
いつも機能追加やメンテナンスしていただきありがとうございます!
動機
#23 (comment) でのコントリビューターとのやり取りを拝見し、PullRequestで正常性チェックができたり、Issue, PullRequestのテンプレートがあればオーナーとコントリビューターと双方の負担軽減になるかと考え、以下の変更を提案いたします。
変更内容
GitHub貢献者向けリソースの包括的な追加と改善を実施しました:
📋 テンプレート・設定ファイル
.github/PULL_REQUEST_TEMPLATE.md) - 統一されたPRフォーマットを提供.github/ISSUE_TEMPLATE/) - バグ報告、機能要求、設定ファイルを追加.github/workflows/pr-checks.yml) - Pull Request作成・更新時の自動検証📚 ドキュメント
docs/CONTRIBUTING.md) - プロジェクトへの貢献方法を詳細に説明*→-に統一しました変更理由
プロジェクトへの貢献をより効率的かつ一貫性のあるものにするため:
テスト方法
以下のコマンドでワークフローとテンプレートの動作を確認:
スクリーンショット(必要な場合)
PullRequestテンプレートやIssueテンプレートはフォークした私のリポジトリで動作確認可能です。
Issue
https://github.com/D-ske104/backlog-exporter/issues
Pull Request
D-ske104#1
Issueテンプレート
PullRequest テンプレート
PullRequest 正常性チェック GitHubActions
関連Issue
#23
チェックリスト
npm run lint)npm run format)補足
プロジェクトへの行動規範
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