Community Guidelines¶
COMMUNITY GUIDELINES
Keep discussions clear, considerate, and reproducible so that questions can receive useful answers.
Core principles¶
Be clear: Describe the subject accurately. Avoid context-free posts such as “it does not work” or “please help.”
Be considerate: Discuss technical facts and proposals without attacking, mocking, or belittling other participants.
Be reproducible: Include enough environment, configuration, and procedural detail for someone else to verify the behavior.
Stay focused: Keep one primary issue in each post and open separate posts for unrelated questions.
Before posting¶
Search the topic center, existing discussions, and project documentation to confirm that the question has not already been answered.
Confirm that you are using supported EAI Simulator and Isaac Sim versions.
Reduce the scene or configuration to the smallest example that still reproduces the issue.
Remove accounts, tokens, internal addresses, and other sensitive information from logs, screenshots, and configuration files.
For reproducible product defects and formal feature requests, also consult the channels listed in the project
SUPPORTdocument.
Choose the right topic¶
General: Usage experience, workflow discussions, and subjects that do not fit another category.
Ideas: Product proposals, research directions, and improvements that need further discussion.
Polls: Questions where the community should help choose a priority or design direction.
Q&A: Posts with a specific question, an expected result, and a verifiable answer.
Show and tell: Environment configurations, experiment results, extensions, and practical examples.
Technical question template¶
Use the following structure when reporting a technical problem:
EAI Simulator version:
Isaac Sim version:
Operating system and GPU:
Scene, robot, and payload:
Expected result:
Actual result:
Minimal reproduction steps:
1.
2.
3.
Relevant logs or screenshots:
Solutions already attempted:
Use code blocks for logs and configuration. Trim long logs to the relevant context. Screenshots should expose the important state, but they should not replace searchable error text.
Moderation and safety¶
Comments become public only after moderator approval. Duplicate posts, advertising, irrelevant or hostile content, and submissions containing sensitive data may be rejected. Published content may also be organized or removed when necessary.
Do not disclose security vulnerabilities, leaked credentials, or issues that could affect user assets in a public discussion. Follow the private reporting process in the repository’s SECURITY.md.
By participating, you agree to follow the project’s Code of Conduct.