docs: add contributing guidelines and PR title format guide #25
Conversation
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
Co-authored-by: groupthinking <[email protected]>
Co-authored-by: groupthinking <[email protected]>
Copilot
AI
changed the title
[WIP] Revise PR title for conventional commits and address review feedback
docs: add contributing guidelines and PR title format guide
Feb 6, 2026
groupthinking
approved these changes
Feb 6, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR establishes comprehensive contribution documentation to address PR #4's non-compliant PR title format. Rather than enforcing strict rules through workflow modifications, it provides clear guidelines and templates to help contributors follow conventional commits format.
Changes:
- Creates CONTRIBUTING.md with full contribution guidelines including conventional commits format, code style references, and PR best practices
- Adds .github/PR_TITLE_GUIDE.md as a quick reference for PR title formatting with examples and a comparison table
- Adds .github/pull_request_template.md to provide a structured template for all new PRs with checklists
- Updates README.md with a Contributing section linking to the new documentation
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds Contributing section with links to contribution guidelines |
| CONTRIBUTING.md | Comprehensive contribution guidelines covering conventional commits, PR format, code style, and testing |
| .github/PR_TITLE_GUIDE.md | Quick reference guide for PR title formatting with type table and common scenarios |
| .github/pull_request_template.md | Standardized PR template with checklist items and conventional commits reminder |
Comment on lines
+121
to
+127
| We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on: | ||
| - PR title format (conventional commits) | ||
| - Code style and conventions | ||
| - Testing requirements | ||
| - How to submit pull requests | ||
|
|
||
| For quick reference on PR titles, see [.github/PR_TITLE_GUIDE.md](.github/PR_TITLE_GUIDE.md). |
There was a problem hiding this comment.
The links in README.md use relative paths (e.g., CONTRIBUTING.md, .github/PR_TITLE_GUIDE.md), but files in .github/ (pull_request_template.md and PR_TITLE_GUIDE.md) use absolute paths starting with / (e.g., /CONTRIBUTING.md). For consistency and reliable rendering across GitHub's web interface, consider using absolute paths in README.md as well:
[CONTRIBUTING.md](/CONTRIBUTING.md)[.github/PR_TITLE_GUIDE.md](/.github/PR_TITLE_GUIDE.md)
This ensures the links work correctly whether viewed from the repository root or from within subdirectories in GitHub's web interface.
Suggested change
| We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on: | |
| - PR title format (conventional commits) | |
| - Code style and conventions | |
| - Testing requirements | |
| - How to submit pull requests | |
| For quick reference on PR titles, see [.github/PR_TITLE_GUIDE.md](.github/PR_TITLE_GUIDE.md). | |
| We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) for guidelines on: | |
| - PR title format (conventional commits) | |
| - Code style and conventions | |
| - Testing requirements | |
| - How to submit pull requests | |
| For quick reference on PR titles, see [.github/PR_TITLE_GUIDE.md](/.github/PR_TITLE_GUIDE.md). |
9 tasks
Copilot AI
added a commit
that referenced
this pull request
Feb 9, 2026
Addresses unresolved review comments from PRs #6, #13, #25, #26: - src/index.ts: Add console.log→stderr redirect with unknown[] type - src/services/xapi.ts: Use URLSearchParams, add Array.isArray guard, add since_id pagination, use unknown type, avoid mutating sort - src/services/agent.ts: Add bounded memory pruning with safe iterator, process mentions oldest-first for chronological ordering - .github/workflows: Add permissions blocks, check labels exist before adding, use pull_request_target for fork PR support - README.md: Add Contributing section with absolute paths - Add CONTRIBUTING.md, PR_TITLE_GUIDE.md, pull_request_template.md Co-authored-by: groupthinking <[email protected]>
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.
Description
Addresses PR #4 feedback about non-compliant PR title format. Creates documentation infrastructure for conventional commits instead of modifying workflow rules.
Motivation
PR validation workflow warns when titles don't follow conventional commits format (
feat:,fix:,docs:, etc.). The workflow already treats this as a warning (not error), so documentation provides the path of least resistance.Changes
For PR #4 specifically, recommended title:
Related Issues
Addresses review comment from PR #4: #4 (comment)
Testing
Checklist
feat:,fix:,docs:)Screenshots / Logs (if applicable)
N/A - Documentation only changes
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.