diff --git a/.github/ISSUE_TEMPLATE/submit-a-request.md b/.github/ISSUE_TEMPLATE/submit-a-request.md index 4f66ac457b6..67076272281 100644 --- a/.github/ISSUE_TEMPLATE/submit-a-request.md +++ b/.github/ISSUE_TEMPLATE/submit-a-request.md @@ -11,6 +11,8 @@ assignees: '' A clear and concise description of what the feature or problem is. +**Note:** This repository is for the GitHub CLI (`gh`) command-line tool. Please ensure your request is related to GitHub CLI functionality, not external applications or services. + ### Proposed solution How will it benefit CLI and its users? diff --git a/.gitignore b/.gitignore index a4b73ac7a50..fc8ef6b89cb 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ /share/man/man1 /share/zsh/site-functions /gh-cli +/gh .envrc /dist /site diff --git a/README.md b/README.md index 2fc58968f8c..4722ef9937e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ `gh` is GitHub on the command line. It brings pull requests, issues, and other GitHub concepts to the terminal next to where you are already working with `git` and your code. +> **Important:** This repository is specifically for the GitHub CLI (`gh`) command-line tool. Issues and requests should be related to GitHub CLI functionality only. For questions about other applications or services, please use the appropriate support channels for those products. + ![screenshot of gh pr status](https://user-images.githubusercontent.com/98482/84171218-327e7a80-aa40-11ea-8cd1-5177fc2d0e72.png) GitHub CLI is supported for users on GitHub.com, GitHub Enterprise Cloud, and GitHub Enterprise Server 2.20+ with support for macOS, Windows, and Linux. diff --git a/docs/issue-guidelines.md b/docs/issue-guidelines.md new file mode 100644 index 00000000000..25859fa3ac8 --- /dev/null +++ b/docs/issue-guidelines.md @@ -0,0 +1,50 @@ +# Issue Guidelines for GitHub CLI + +This document provides guidance on what types of issues are appropriate for the GitHub CLI repository and how to handle requests that fall outside the scope of this project. + +## What belongs in this repository + +The GitHub CLI (`gh`) repository is specifically for: + +- Bug reports related to the `gh` command-line tool +- Feature requests for new GitHub CLI functionality +- Documentation improvements for the CLI +- Enhancement requests for existing CLI commands + +## What does NOT belong in this repository + +Issues that should be redirected to other repositories or support channels: + +- **External applications**: Requests for Microsoft Store apps, browser extensions, or other third-party software +- **GitHub.com website issues**: Use [GitHub Support](https://support.github.com/) instead +- **GitHub API questions**: Use the [GitHub Community](https://github.community/) forum +- **General programming questions**: Use [Stack Overflow](https://stackoverflow.com/) or similar platforms +- **Other GitHub products**: Use the specific repository or support channel for that product + +## How to handle inappropriate issues + +If you encounter an issue that doesn't belong in this repository: + +1. **Be polite and helpful** when redirecting users +2. **Explain why** the issue doesn't belong here +3. **Provide alternative resources** where appropriate +4. **Close the issue** with a clear explanation + +### Example response for inappropriate issues + +``` +Hi @username, + +Thank you for opening this issue. However, this repository is specifically for the GitHub CLI (`gh`) command-line tool. Your request for [brief description] appears to be unrelated to the GitHub CLI functionality. + +For [appropriate alternative], please [specific guidance/link]. + +I'm closing this issue as it's outside the scope of this repository. If you have any questions about the GitHub CLI specifically, feel free to open a new issue with details about the CLI functionality you'd like to see. +``` + +## Resources + +- [Contributing Guidelines](.github/CONTRIBUTING.md) +- [GitHub CLI Manual](https://cli.github.com/manual/) +- [GitHub Support](https://support.github.com/) +- [GitHub Community Forum](https://github.community/) \ No newline at end of file