chore: improve code quality and documentation#1
Conversation
- Add .gitignore for common files (macOS, editors, logs, etc.) - Add issue template config with links to docs and discussions - Improve README with Table of Contents, Security section, Contributing guidelines - Fix typo in workflow name (tab -> label) - Add missing pull-requests permission to stale-issues workflow - Add repo-token to stale-issues workflow
There was a problem hiding this comment.
Pull request overview
This PR focuses on repo hygiene and community-facing documentation by adding standard ignore rules, improving GitHub issue intake UX, refining README guidance (including security guidance), and tightening a couple of GitHub Actions workflows.
Changes:
- Added a standard
.gitignorefor common OS/editor/dependency/build artifacts. - Added
.github/ISSUE_TEMPLATE/config.ymlto disable blank issues and route users to docs/discussions. - Updated README structure (ToC, platform table, security guidance, contributing/license sections) and adjusted workflows (stale action permissions/token; workflow name typo fix).
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds ToC, security/feedback/contributing/license sections and improves formatting. |
| .gitignore | Introduces common ignore patterns for local/dev artifacts. |
| .github/workflows/stale-issues.yml | Grants PR write permission and supplies repo token to actions/stale. |
| .github/workflows/on-issue-close.yml | Fixes workflow name text (“tab” → “label”). |
| .github/ISSUE_TEMPLATE/config.yml | Disables blank issues and adds contact links to docs/discussions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **Opening an issue:** Report bugs or request features using our [issue templates](/.github/ISSUE_TEMPLATE/) | ||
| - **Joining Discussions:** Participate in community conversations | ||
| - **Submitting feedback:** Run `/feedback` from the CLI to submit a confidential feedback survey |
There was a problem hiding this comment.
The link to the issue templates uses an absolute path (/.github/ISSUE_TEMPLATE/), which GitHub renders as https://github.com/.github/ISSUE_TEMPLATE/ (not this repo). Use a repo-relative link (e.g., ./.github/ISSUE_TEMPLATE/) or link directly to the issue chooser page (https://github.com/github/copilot-cli/issues/new/choose).
| 2. Search existing [issues](https://github.com/github/copilot-cli/issues) to see if your question has been addressed | ||
| 3. Open a new issue using the appropriate [issue template](/.github/ISSUE_TEMPLATE/) | ||
|
|
There was a problem hiding this comment.
This issue-template link uses an absolute path (/.github/ISSUE_TEMPLATE/), which points to github.com/.github/... instead of this repository. Prefer a repo-relative link (e.g., ./.github/ISSUE_TEMPLATE/) or https://github.com/github/copilot-cli/issues/new/choose.
Summary
This PR improves code quality and documentation for the repository:
.gitignorefile with common patterns for macOS, editors, logs, dependencies, environment files, temporary files, build outputs, test coverage, and OS-generated files.github/ISSUE_TEMPLATE/config.ymlto guide users to official documentation and GitHub Discussions before opening blank issuestab->label)pull-requests: writepermission to stale-issues workflowrepo-tokento stale-issues workflowTest plan