From f84818d9a9409e05a2800c423793de3b90824d4d Mon Sep 17 00:00:00 2001 From: Aung Myo Kyaw Date: Mon, 16 Feb 2026 09:24:58 +0700 Subject: [PATCH] chore: improve code quality and documentation - 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 --- .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/workflows/on-issue-close.yml | 2 +- .github/workflows/stale-issues.yml | 2 + .gitignore | 43 ++++++++++++++++++ README.md | 67 ++++++++++++++++++++++++---- 5 files changed, 112 insertions(+), 10 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .gitignore diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0de746d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: ๐Ÿ“š Official Documentation + url: https://docs.github.com/copilot/concepts/agents/about-copilot-cli + about: Check the official documentation for usage guides and FAQs + - name: ๐Ÿ’ฌ GitHub Discussions + url: https://github.com/github/copilot-cli/discussions + about: Join community discussions and ask questions diff --git a/.github/workflows/on-issue-close.yml b/.github/workflows/on-issue-close.yml index e768226d..b60afac6 100644 --- a/.github/workflows/on-issue-close.yml +++ b/.github/workflows/on-issue-close.yml @@ -1,4 +1,4 @@ -name: Remove triage tab from closed issues +name: Remove triage label from closed issues on: issues: types: diff --git a/.github/workflows/stale-issues.yml b/.github/workflows/stale-issues.yml index 3ec537c4..57f1f3f2 100644 --- a/.github/workflows/stale-issues.yml +++ b/.github/workflows/stale-issues.yml @@ -5,6 +5,7 @@ on: permissions: issues: write + pull-requests: write jobs: stale: @@ -18,3 +19,4 @@ jobs: days-before-close: -1 # If -1, the issues nor pull requests will never be closed automatically. days-before-pr-stale: -1 # If -1, no pull requests will be marked as stale automatically. exempt-issue-labels: 'never-stale, help wanted' # issues labeled as such will be excluded them from being marked as stale + repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..81b94b5a --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +# macOS +.DS_Store +.AppleDouble +.LSOverride +._* + +# Editor/IDE +.idea/ +.vscode/ +*.swp +*.swo +*~ + +# Logs +*.log +npm-debug.log* + +# Dependencies (if any local development) +node_modules/ + +# Environment files +.env +.env.local +.env.*.local + +# Temporary files +*.tmp +*.temp +.tmp/ +.temp/ + +# Build outputs (if any) +dist/ +build/ +out/ + +# Test coverage +coverage/ + +# OS generated files +Thumbs.db +ehthumbs.db +Desktop.ini diff --git a/README.md b/README.md index 96e0ef69..47baba41 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,21 @@ See [our official documentation](https://docs.github.com/copilot/concepts/agents ![Image of the splash screen for the Copilot CLI](https://github.com/user-attachments/assets/51ac25d2-c074-467a-9c88-38a8d76690e3) +## Table of Contents + +- [Introduction and Overview](#-introduction-and-overview) +- [Getting Started](#-getting-started) + - [Supported Platforms](#supported-platforms) + - [Prerequisites](#prerequisites) + - [Installation](#installation) + - [Launching the CLI](#launching-the-cli) + - [Authentication](#authenticate-with-a-personal-access-token-pat) + - [Using the CLI](#using-the-cli) +- [Security](#-security) +- [Feedback and Participation](#-feedback-and-participation) +- [Contributing](#-contributing) +- [License](#-license) + ## ๐Ÿš€ Introduction and Overview We're bringing the power of GitHub Copilot coding agent directly to your terminal. With GitHub Copilot CLI, you can work locally and synchronously with an AI agent that understands your code and GitHub context. @@ -24,9 +39,11 @@ We're still early in our journey, but with your feedback, we're rapidly iteratin ### Supported Platforms -- **Linux** -- **macOS** -- **Windows** (experimental) +| Platform | Support Level | +|----------|---------------| +| Linux | Full Support | +| macOS | Full Support | +| Windows | Experimental | ### Prerequisites @@ -35,11 +52,12 @@ We're still early in our journey, but with your feedback, we're rapidly iteratin - (On Windows) **PowerShell** v6 or higher - An **active Copilot subscription**. See [Copilot plans](https://github.com/features/copilot/plans?ref_cta=Copilot+plans+signup&ref_loc=install-copilot-cli&ref_page=docs). -If you have access to GitHub Copilot via your organization of enterprise, you cannot use GitHub Copilot CLI if your organization owner or enterprise administrator has disabled it in the organization or enterprise settings. See [Managing policies and features for GitHub Copilot in your organization](http://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization) for more information. +> **Note:** If you have access to GitHub Copilot via your organization or enterprise, you cannot use GitHub Copilot CLI if your organization owner or enterprise administrator has disabled it in the organization or enterprise settings. See [Managing policies and features for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization) for more information. ### Installation Install globally with npm: + ```bash npm install -g @github/copilot ``` @@ -50,7 +68,7 @@ npm install -g @github/copilot copilot ``` -On first launch, you'll be greeted with our adorable animated banner! If you'd like to see this banner again, launch `copilot` with the `--banner` flag. +On first launch, you'll be greeted with our adorable animated banner! If you'd like to see this banner again, launch `copilot` with the `--banner` flag. If you're not currently logged in to GitHub, you'll be prompted to use the `/login` slash command. Enter this command and follow the on-screen instructions to authenticate. @@ -65,19 +83,50 @@ You can also authenticate using a fine-grained PAT with the "Copilot Requests" p ### Using the CLI -Launch `copilot` in a folder that contains code you want to work with. +Launch `copilot` in a folder that contains code you want to work with. -By default, `copilot` utilizes Claude Sonnet 4.5. Run the `/model` slash command to choose from other available models, including Claude Sonnet 4 and GPT-5 +By default, `copilot` utilizes Claude Sonnet 4.5. Run the `/model` slash command to choose from other available models, including Claude Sonnet 4 and GPT-5. Each time you submit a prompt to GitHub Copilot CLI, your monthly quota of premium requests is reduced by one. For information about premium requests, see [About premium requests](https://docs.github.com/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests). For more information about how to use the GitHub Copilot CLI, see [our official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli). +## ๐Ÿ” Security + +### Token Security + +- **Never commit tokens to version control.** Always use environment variables for authentication tokens. +- Use fine-grained Personal Access Tokens (PATs) with minimal required permissions. +- The `GH_TOKEN` and `GITHUB_TOKEN` environment variables are read at runtime and should be stored securely. +- Consider using a credential manager or secret management solution for storing tokens. + +### Best Practices + +- Review all proposed actions before approving them in the CLI. +- Be cautious when running Copilot CLI on sensitive or proprietary codebases. +- Regularly update to the latest version to receive security patches. +- Report security vulnerabilities through [GitHub Security](https://github.com/github/copilot-cli/security) rather than public issues. ## ๐Ÿ“ข Feedback and Participation We're excited to have you join us early in the Copilot CLI journey. -This is an early-stage preview, and we're building quickly. Expect frequent updates--please keep your client up to date for the latest features and fixes! +This is an early-stage preview, and we're building quickly. Expect frequent updatesโ€”please keep your client up to date for the latest features and fixes! + +Your insights are invaluable! You can contribute by: + +- **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 + +## ๐Ÿค Contributing + +This repository primarily serves as a place for issue tracking and community feedback. For questions or support: + +1. Check the [official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) +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/) + +## ๐Ÿ“„ License -Your insights are invaluable! Open issue in this repo, join Discussions, and run `/feedback` from the CLI to submit a confidential feedback survey! +Copyright (c) GitHub 2025. All rights reserved. Use is subject to GitHub's [Pre-release License Terms](https://docs.github.com/en/site-policy/github-terms/github-pre-release-license-terms).