Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

adding-support-resources-to-your-project.md 1.8 KB

You have to be logged in to leave a comment. Sign In
title intro redirect_from versions topics
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 /github/building-a-strong-community/adding-support-resources-to-your-project] [{free-pro-team *} {enterprise-server *} {github-ae *}] [Community]

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

{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}

You can create default support resources for your organization or user account. For more information, see "Creating a default community health file."

{% endif %}

{% 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 %}

Tip!

Press p or to see the previous file or, n or to see the next file

Comments

Loading...