.github/SUPPORT.md

In dmurdoch/rgl2gltf: Read and Write '.gltf' and '.glb' Files

Getting help with rgl2gltf

Before filing an issue, there are a few places to explore and pieces to put together to make the process as smooth as possible.

Make a reprex

Start by making a minimal reproducible example using the reprex package. If you haven't heard of or used the reprex package before, you'll already have gained by learning it. reprex will make all of your R-question-asking endeavors easier (which is an amazing ROI for the five to ten minutes it'll take you to learn what it's all about).

Where to ask?

Armed with your reprex, the next step is to figure out where to ask.

• If it's a question: start with stackoverflow. You can use r and rgl as tags in your question and lots of knowledgeable people will see it.

• If it's a bug: you're in the right place, file an issue.

• If you're not sure: let the community help you figure it out! If your problem is a bug or a feature request, you can easily return here and report it.

Before opening a new issue, be sure to search issues and pull requests to make sure the bug hasn't been reported and/or already fixed in the development version. By default, the search will be pre-populated with is:issue is:open. You can edit the qualifiers (e.g. is:pr, is:closed) as needed. For example, you'd simply remove is:open to search all issues in the repo, open or closed.

What about a PR?

Pull requests are welcome. We don't require copyright transfer, but we do need you to allow us to license your contribution under rgl2gltf's GPL license.

What happens next?

Development of rgl2gltf is quite active right now, so you'll likely get some comment quite quickly. But do put a reprex together to make it easier to understand. If we can’t reproduce the bug, we can’t fix it!

Credits

This page is based on one found in a tidyverse project. Thanks to the original authors!

dmurdoch/rgl2gltf documentation built on Nov. 19, 2024, 9:41 p.m.