Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #1585

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 23 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,24 @@ To ensure an inclusive community, contributors and users in the Cesium community

# Submitting an Issue {#submitting-an-issue}

If you have a question, do not submit an issue; instead, search the [Cesium community forum](https://community.cesium.com/). 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 have a question, **do not submit an issue**. Instead, search the [Cesium community forum](https://community.cesium.com/) 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 [issues](https://github.com/CesiumGS/cesium-unreal/issues). If an issue already exists, please add a comment expressing your interest and any additional information. This helps us prioritize issues.
If you think you've found a bug in Cesium for Unreal, first search the existing [issues](https://github.com/CesiumGS/cesium-unreal/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, submit a new one. Please be concise and include as much of the following information as is relevant:
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:

- The version of Cesium for Unreal. Did this work in a previous version?
- Your operating system and version, Unreal Engine version, and video card. Are they all up-to-date? Is the issue specific to one of them?
- If possible, an Unreal project (and data or IDs of Cesium ion assets that have been used) where the issue can be reproduced.
- 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](https://github.com/CesiumGS/cesium-unreal-samples)?
- A Screenshot, video or animated .gif if appropriate. Screenshots are particularly useful for exceptions and rendering artifacts.
- Information about whether the issue appeared in the Unreal Editor or in the play mode.
- If the issue is about a crash of the Unreal Editor, include the stack trace that is shown together with the error message.
- Depending on the type of the issue, it can be helpful to see the log files that have been created before encountering the unexpected behavior. The log files is stored as `Saved\Logs\cesiumunreal.log` in your project directory.
- A link to the thread if this was discussed on the [Cesium community forum](https://community.cesium.com/) or elsewhere.
- 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.
- 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.log` in your project directory.
- Share a screenshot, video or animated `.gif` if appropriate. Screenshots are particularly useful for exceptions and rendering artifacts.
- Link to threads on the [Cesium community forum](https://community.cesium.com/) 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](https://github.com/CesiumGS/cesium-unreal-samples) or from a blank project. We will only request your Unreal project and/or data as a last resort.

# Getting Started Contributing {#getting-started-contributing}

Expand All @@ -41,16 +43,17 @@ In addition to contributing code, we appreciate many types of contributions:

- Being active on the [Cesium community forum](https://community.cesium.com/) by answering questions and providing input on Cesium's direction.
- Showcasing your Cesium for Unreal apps on [Cesium blog](https://cesium.com/blog/categories/userstories/). Contact us at [email protected].
- Writing tutorials, creating examples, and improving the reference documentation. See the issues labeled [category - doc](https://github.com/CesiumGS/cesium-unreal/labels/category%20-%20doc).
- Writing tutorials, creating examples, and improving the reference documentation. See the issues labeled [documentation](https://github.com/CesiumGS/cesium-unreal/labels/documentation).
- Submitting issues as [described above](#submitting-an-issue).
- Triaging issues. Browse the [issues](https://github.com/CesiumGS/cesium-unreal/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`](https://github.com/CesiumGS/cesium-unreal/labels/good%20first%20issue) and
- issues labeled [`type - roadmap`](https://github.com/CesiumGS/cesium-unreal/labels/type%20-%20roadmap).
- issues labeled [`good first issue`](https://github.com/CesiumGS/cesium-unreal/labels/good%20first%20issue),
- issues labeled [`low hanging fruit`](https://github.com/CesiumGS/cesium-unreal/labels/low%20hanging%20fruit), and
- issues labeled [`enhancement`](https://github.com/CesiumGS/cesium-unreal/labels/enhancement).

See the [build guide](https://github.com/CesiumGS/cesium-unreal#computer-developing-with-unreal-engine) for how to build and run Cesium for Unreal.
See [Developer Setup](https://cesium.com/learn/cesium-unreal/ref-doc/developer-setup-unreal.html) for how to build and run Cesium for Unreal.

Always feel free to introduce yourself on the [Cesium community forum](https://community.cesium.com/) to brainstorm ideas and ask for guidance.

Expand All @@ -62,27 +65,19 @@ We love pull requests. We strive to promptly review them, provide feedback, and

## Contributor License Agreement (CLA)

Before we can review a pull request, we require a signed Contributor License Agreement. There is a CLA for:

- [individuals](https://docs.google.com/forms/d/e/1FAIpQLScU-yvQdcdjCFHkNXwdNeEXx5Qhu45QXuWX_uF5qiLGFSEwlA/viewform) and
- [corporations](https://docs.google.com/forms/d/e/1FAIpQLSeYEaWlBl1tQEiegfHMuqnH9VxyfgXGyIw13C2sN7Fj3J3GVA/viewform).

This only needs to be completed once, and enables contributions to all of the projects under the [CesiumGS](https://github.com/CesiumGS) organization, including Cesium for Unreal. The CLA ensures you retain copyright to your contributions, and provides us the right to use, modify, and redistribute your contributions using the [Apache 2.0 License](LICENSE). If you have already signed a CLA for CesiumJS or other contributions to Cesium, you will not need to sign it again.

If you have any questions, feel free to reach out to [email protected]!
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](https://github.com/CesiumGS/community/tree/main/CLAs).

## Pull Request Guidelines

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](https://cesium.com/blog/2013/10/08/github-pull-request-workflows/).
- Pull request tips
- After you open a pull request, the friendly [cesium-concierge](https://github.com/CesiumGS/cesium-concierge) bot will comment with a short automated review. At least one human will also review your pull request.
- 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](https://github.com/CesiumGS/cesium-unreal/issues/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](https://github.com/blog/1375%0A-task-lists-in-gfm-issues-pulls-comments).
- Once you are done making new commits to address feedback, add a comment to the pull request such as `"this is ready"` since GitHub doesn't notify us about commits.
- Follow the [Coding Guide](https://github.com/CesiumGS/cesium-native/blob/main/doc/style-guide.md).
- Verify your is formatted, as described in the Coding Guide.
- 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](https://github.com/CesiumGS/cesium-native/blob/main/doc/style-guide.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I missed this the first time around, but this link is now broken as the style guide has been moved to doc/topics/style-guide.md instead. But we should probably link to https://cesium.com/learn/cesium-native/ref-doc/style-guide.html now.


## Code of Conduct

Expand Down
Loading