Skip to content

SUPPORT.md

Latest commit

 

History

History
77 lines (52 loc) · 2.92 KB

SUPPORT.md

File metadata and controls

77 lines (52 loc) · 2.92 KB

Support

Need help getting started, building, or using a Source Robotics project?
Here’s how to get the right kind of help while keeping things efficient for everyone.

👉 Note: Before participating in our community, please read our Code of Conduct.
By interacting with this repository, organization, or community, you agree to abide by its terms.

How to Get Help

We love helping our community, but please follow these steps first:

  1. 📖 Read the documentation

    • Check the docs or readme of the related project
    • Explore any example projects to see how they work.
    • Many answers can be found in Discord or Forum without waiting for a reply

  2. 🔍 Search before asking

    • Look for similar issues in the GitHub repository.
    • Search on Stack Overflow for common problems (related to basic stuff like git, python, compilation errors...)
    • Use Google, Chatgot or your favorite search engine for related terms.

  3. 💬 Ask in our community channels

    • Discord – for quick discussions and brainstorming
    • Forum – for detailed technical questions

  4. 📝 As a last resort, open a GitHub Issue

    • Clearly describe your problem or question.
    • Include what you have already tried.
    • Provide relevant code snippets or error messages (not your entire project).

Asking High-Quality Questions

Help us help you!
A well-structured question saves everyone time.

  • Clearly define your goal:
    • What are you trying to do?
    • What’s the exact problem?
    • What have you already tried?
  • Avoid the XY Problem — ask about your actual goal, not just your attempted solution.
  • Screenshots are helpful, but also include important text (like error logs) as plain text.

What Not to Do

Please do not:

  • ❌ DM or email maintainers asking for free private support
  • ❌ Open duplicate issues or spam "+1" comments
  • ❌ Post vague questions without details or steps to reproduce

Public questions get public answers — this helps the whole community.

Contributions

If you find a bug or have an improvement idea:

No Customer Support Policy

Source Robotics is an open-source initiative.
We do not offer traditional "customer support."
For paid consulting or hardware integration work, please reach out via our website.

Thank you for helping us keep the community welcoming, productive, and fun! 🚀