Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 5.19 KB

SUPPORT.md

File metadata and controls

70 lines (44 loc) · 5.19 KB
Raw

Support

This document provides support information for all repositories under the Cloud Posse organization.

We value your involvement in the Cloud Posse community and look forward to your contributions and questions.

Thank you for being part of our community!

Tip

Where to Find Support

If you're looking for support for any Cloud Posse projects, here are a few options to consider.

Documentation

Before seeking support, please make sure to check our documentation. Each project in the Cloud Posse organization typically has its own set of documentation, which can be found in the repository's README.md file or in a dedicated docs directory. We also have a developer documentation portal which collates all our documentation into one place that is searchable.

Issues

If you believe you have found a bug or if you have a feature request, please use the GitHub issue tracker of the specific repository. Before creating a new issue, please:

  • Check that the issue has not already been reported or fixed.
  • Ensure that the issue is related to the specific project and not a dependency or a broader system issue.

Discussions

For questions, ideas, and general discussion, we encourage the use of our organization's GitHub Discussions. This is a great place to seek help, share your knowledge, and engage with the Cloud Posse community.

Community Channels

Cloud Posse also maintains community Slack Team & Channels. These can be great places to seek real-time help or advice from the community and the Cloud Posse team.

How to Contribute

We love contributions! If you're interested in helping out, check out the CONTRIBUTING.md file in the respective repository for guidelines on how to contribute.

Professional Support

For professional support, please contact Cloud Posse directly. Please note that while we strive to provide community support wherever possible, professional support will involve costs or service agreements. README Commercial Support

Security Issues

For security issues, please do not post them publicly on the forums, issue trackers, or discussions. Instead, refer to our security policy outlined in SECURITY.md in the respective repository.

Guidelines When Asking for Help

Tip

Tips to follow when asking for help

We appreciate that not everyone has all the answers every time. That’s exactly why our community is here to help. Keep in mind, we are all volunteers. Everyone donates their time; no one receives any payment for helping answer your questions.

  1. Research the problem or question. Be prepared to share links of what you’ve already tried and considered. We expect you’ve “Googled it” before we do. If you don’t know where to begin, that’s okay. In that case, ask for help on how to approach the problem.
  2. State your problem, not just your solution. The XY Problem is the fallacy of asking for help about your attempted solution rather than ask for help solving your actual problem. This leads to enormous amounts of wasted time and energy, both on the part of people asking for help, and on the part of those providing help.
  3. Search our Slack for the answer. We see a lot of the same questions asked over and over again. Do a quick search before asking your question.
  4. Ask Constructive Questions. When asking your question, mention any research you’ve done, relevant links and GitHub issues, as well as provide any relevant code samples.
  5. Use Markdown Formatting. When pasting code samples, make sure you use markdown formatting. Code that is not formatted makes it difficult for others to read and reduce the likelihood of getting an answer. For longer blobs of text, make sure you use snippets.IMPORTANT: Make sure you have permission to share any code samples because these will be public.
  6. Use the Appropriate Channel. We have dozens of channels that help us organize all the information and questions asked. The #general channel is only for welcoming new users or asking for help on where to ask a question.
  7. Do Not Cross-Post. Use one channel at a time to avoid spamming our community. Keep in mind, users are in 57 timezones. You may not get an answer right away.
  8. ** Keep Conversations in Threads.** Our channels get pretty busy. When multiple concurrent conversations are happening, it’s hard to keep it straight. Also, it’s helpful if you add supplementary information in the thread of the question, rather than posting a new message.
  9. Give Copious Praise. Did you get the answer you were looking for? Did someone help you? Let them know! We operate on praise. There’s never enough.