Thanks for contributing to Cesium for Unreal!
Here are the guidelines that we use for all contributions to this project:
To ensure an inclusive community, contributors and users in the Cesium community should follow the code of conduct.
If you have a question, do not submit an issue. Instead, search the Cesium community forum for your question. The forum is very active and there are years of informative archives for the Cesium platform, often with answers from the core Cesium team. If you do not find an answer to your question, start a new thread and you'll likely get a quick response.
If you think you've found a bug in Cesium for Unreal, first search the existing issues. If an issue already exists, please add a comment expressing your interest and any additional information. This helps us stay organized and prioritize issues.
If a related issue does not exist, then you can submit a new one. Please include as much of the following information as is relevant:
- What version of Cesium for Unreal were you using? Do other versions have the same issue?
- What version of Unreal Engine were you using?
- What is your operating system and version, and your video card? Are they up-to-date? Is the issue specific to one of them?
- Can the issue be reproduced in the Cesium for Unreal Samples?
- Does the issue occur in the Unreal Editor? In Play Mode? Both?
- Are there any error messages in the console? Any stack traces or logs? Please include them if so. Logs are stored as
Saved\Logs\cesiumunreal.login your project directory. - Share a screenshot, video or animated
.gifif appropriate. Screenshots are particularly useful for exceptions and rendering artifacts. - Link to threads on the Cesium community forum if this was discussed on there.
- Include step-by-step instructions for us to reproduce the issue from scratch.
- Any ideas for how to fix or workaround the issue. Also mention if you are willing to help fix it. If so, the Cesium team can often provide guidance and the issue may get fixed more quickly with your help.
Note: It is difficult for us to debug everyone's individual projects. We can triage issues faster when we receive steps to reproduce the issue from scratch—either from Cesium for Unreal Samples or from a blank project. We will only request your Unreal project and/or data as a last resort.
Everyone is welcome to contribute to Cesium for Unreal!
In addition to contributing code, we appreciate many types of contributions:
- Being active on the Cesium community forum by answering questions and providing input on Cesium's direction.
- Showcasing your Cesium for Unreal apps on Cesium blog. Contact us at hello@cesium.com.
- Writing tutorials, creating examples, and improving the reference documentation. See the issues labeled documentation.
- Submitting issues as described above.
- Triaging issues. Browse the issues and comment on issues that are no longer reproducible or on issues for which you have additional information.
For ideas for Cesium for Unreal code contributions, see:
- issues labeled
good first issue, - issues labeled
low hanging fruit, and - issues labeled
enhancement.
See Developer Setup for how to build and run Cesium for Unreal.
Always feel free to introduce yourself on the Cesium community forum to brainstorm ideas and ask for guidance.
We love pull requests. We strive to promptly review them, provide feedback, and merge. Interest in Cesium is at an all-time high so the core team is busy. Following the tips in this guide will help your pull request get merged quickly.
If you plan to make a major change, please start a new thread on the Cesium community forum first. Pull requests for small features and bug fixes can generally just be opened without discussion on the forum.
Before we can review a pull request, we require a signed Contributor License Agreement. The CLA forms can be found in our community repo here.
Our code is our lifeblood so maintaining Cesium's high code quality is important to us.
- For an overview of our workflow see github pull request workflows.
- Pull request tips
- After you open a pull request, one or more Cesium teammates will review your pull request.
- If your pull request fixes an existing issue, include a link to the issue in the description (like this: #1). Likewise, if your pull request fixes an issue reported on the Cesium forum, include a link to the thread.
- If your pull request needs additional work, include a task list.
- Once you are done making new commits to address feedback, add a comment to the pull request such as
"this is ready"so we know to take another look. - Verify that your code conforms to our Style Guide.
To ensure an inclusive community, contributors and users in the Cesium community should follow the code of conduct.