Skip to content

Latest commit

 

History

History
116 lines (72 loc) · 1.88 KB

SUPPORT.md

File metadata and controls

116 lines (72 loc) · 1.88 KB

OpenAMRobot Support

Purpose

This document explains how to request help, report issues, and participate in discussions within the OpenAMRobot ecosystem.


Getting Help

For technical questions, usage help, or feature discussions, use:

  • GitHub Issues
  • GitHub Discussions
  • repository documentation
  • project READMEs

Please search existing discussions before opening new issues.


Reporting Bugs

When reporting bugs, try to include:

  • repository name
  • software version or commit hash
  • operating system
  • ROS version if applicable
  • hardware information if relevant
  • reproduction steps
  • logs or screenshots when possible

Clear reports help maintainers reproduce and resolve issues faster.


Feature Requests

Feature requests are welcome.

Please explain:

  • the problem being solved
  • the proposed improvement
  • possible implementation ideas
  • expected benefits

Large architectural proposals should ideally begin as Discussions before implementation.


Experimental Nature

Many OpenAMRobot repositories are experimental and research-oriented.

Features may:

  • change rapidly
  • be incomplete
  • contain limitations
  • require advanced technical knowledge

Not all repositories are production-ready.


Community Support

OpenAMRobot is community-driven.

Community contributions to:

  • documentation
  • issue triage
  • tutorials
  • testing
  • pull request reviews

are highly appreciated.


Safety Reminder

OpenAMRobot projects may involve:

  • robotics
  • autonomous systems
  • motors
  • batteries
  • electronics
  • AI systems

Users are responsible for validating:

  • safety
  • regulatory compliance
  • deployment suitability
  • operational reliability

Security Issues

For security-related concerns, see:

  • SECURITY.md

Avoid publicly disclosing sensitive vulnerabilities before maintainers can review them.


Policy Updates

This document may evolve as the ecosystem grows.