Add GitHub Issue and Discussion templates.

PiperOrigin-RevId: 669365189
Change-Id: I6e14bdf68de0ddc0029937291d7258d26eb65b75
This commit is contained in:
Yuval Tassa
2024-08-30 10:12:53 -07:00
committed by Copybara-Service
parent 5391e6011a
commit 651868ab05
8 changed files with 197 additions and 129 deletions
+6 -36
View File
@@ -99,44 +99,14 @@ and [style guide](STYLEGUIDE.md).
## Asking Questions
Questions and requests for help are welcome on the GitHub
[Issues](https://github.com/google-deepmind/mujoco/issues) page and should focus
on a specific problem or question.
Questions and requests for help are welcome as a GitHub
["Asking for Help" Discussion](https://github.com/google-deepmind/mujoco/discussions/categories/asking-for-help)
and should focus on a specific problem or question.
[Discussions](https://github.com/google-deepmind/mujoco/discussions) should
address wider concerns that might require input from multiple participants.
## Bug reports and feature requests
Here are some guidelines for asking good questions:
1. Search for existing questions or issues that touch on the same subject.
You can add comments to existing threads or start new ones. If you start a
new thread and there are existing relevant threads, please link to them.
2. Use a clear and specific title. Try to include keywords that will make your
question easy for other to find in the future.
3. Introduce yourself and your project more generally.
If your level of expertise is exceptional (either high or low), and it might
be relevant to what we can assume you know, please state that as well.
4. Take a step back and tell us what you're trying to accomplish, if we
understand you goal we might suggest a different type of solution than the
one you are having problems with
5. Make it easy for others to reproduce the problem or understand your question.
If this requires a model, please include it. Try to make the model minimal:
remove elements that are unrelated to your question. Pure XML models should
be inlined. Models requiring binary assets (meshes, textures), should be
attached as a `.zip` file. Please make sure the included model is loadable
before you attach it.
6. Include an illustrative screenshot or video, if relevant.
7. Tell us how you are accessing MuJoCo (C API, Python bindings, etc.) and which
MuJoCo version and operating system you are using.
GitHub [Issues](https://github.com/google-deepmind/mujoco/issues) are reserved
for bug reports, feature requests and other development-related subjects.
## Related software
MuJoCo forms the backbone of many environment packages, but these are too many