Klectr/.github
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update SUPPORT.md

Browse Source
This commit is contained in:
Jesse Squires 2020-01-19 11:57:46 -08:00 committed by GitHub
parent 2c8cd4ed73
commit 040e979954
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
SUPPORT.md
View File

@ -4,15 +4,17 @@ Need help getting started or using a project? Here's how.
## How to get help ## How to get help
Generally, we do not use GitHub as a support forum. For any usage questions that are not specific to the project itself, please ask on [Stack Overflow](https://stackoverflow.com) instead. By doing so, you are more likely to quickly solve your problem, and you will allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others.
Please seek support in the following ways: Please seek support in the following ways:
1. :book: Read the documentation and guides for the project to see if you can figure it out on your own. These should be located in a root `docs/` directory. If there is an example project, explore that to learn how it works. 1. :book: **Read the documentation and other guides** for the project to see if you can figure it out on your own. These should be located in a root `docs/` directory. If there is an example project, explore that to learn how it works to see if you can answer your question.
1. :bulb: Ask questions on [Stack Overflow](https://stackoverflow.com). This is usually the most appropriate place for debugging issues specific to your use of the project, or figuring out how to use the project in a specific way. 1. :bulb: **Search for answers and ask questions on [Stack Overflow](https://stackoverflow.com).** This is the most appropriate place for debugging issues specific to your use of the project, or figuring out how to use the project in a specific way.
1. :memo: If you do not succeed with either of those, please open an issue on GitHub to ask for help. Please clearly explain what you are trying to do, and list what you have already attempted to solve the problem. 1. :memo: As a **last resort**, you may open an issue on GitHub to ask for help. However, please clearly explain what you are trying to do, and list what you have already attempted to solve the problem. Provide code samples, but **do not** attach your entire project for someone else to debug. Review our [contributing guidelines](https://github.com/jessesquires/.github/blob/master/CONTRIBUTING.md).
## Things NOT to do ## What NOT to do
Please **do not** do any the following: Please **do not** do any the following:
@ -20,6 +22,8 @@ Please **do not** do any the following:
1. :x: Do not email the author or contributor. 1. :x: Do not email the author or contributor.
1. :x: Do not open duplicate issues or litter an existing issue with +1's.
These are not appropriate avenues for seeking help or support with an open-source project. Please follow the guidelines in the previous section. Public questions get public answers, which benefits everyone in the community. ✌️ These are not appropriate avenues for seeking help or support with an open-source project. Please follow the guidelines in the previous section. Public questions get public answers, which benefits everyone in the community. ✌️
## Customer Support ## Customer Support