To direct people to specific support resources, you can add a SUPPORT file to your repository's root, docs, or .github folder. When someone creates an issue in your repository, they will see a link to your project's SUPPORT file.
You can create default support resources for your organization or user account. For more information, see "Creating a default community health file."
Tip: To help people find your support guidelines, you can link to your SUPPORT file from other places in your repository, such as your README file.
Adding support resources to your project
-
On GitHub.com, navigate to the main page of the repository.
-
Above the list of files, using the Add file drop-down, click Create new file.
-
In the file name field, type SUPPORT.md (with all caps).
-
On the Edit new file tab, add information about how people can get support for your project.
-
To review your SUPPORT file, click Preview.
-
At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."
-
If you have more than one email address associated with your account on GitHub.com, click the email address drop-down menu and select the email address to use as the Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then
<username>@users.noreply.github.comis the default commit author email address. For more information, see "Setting your commit email address."
-
Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is the default branch, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."
-
Click Propose new file.
