1
0
mirror of synced 2025-12-22 11:26:57 -05:00
Files
docs/content/github/building-a-strong-community/adding-support-resources-to-your-project.md
2020-11-02 15:12:44 -06:00

1.7 KiB

title, intro, redirect_from, versions
title intro redirect_from versions
Adding support resources to your project You can create a SUPPORT file to let people know about ways to get help with your project.
/articles/adding-support-resources-to-your-project
free-pro-team enterprise-server github-ae
* * *

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.

Support guidelines

You can create default support resources for your organization{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} or user account{% endif %}. For more information, see "Creating a default community health file."

{% tip %}

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.

{% endtip %}

Adding support resources to your project

{% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} 3. In the file name field, type SUPPORT.md (with all caps). 4. On the Edit new file tab, add information about how people can get support for your project. 5. To review your SUPPORT file, click Preview. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %}