Skip to content

Commit 438ddbb

Browse files
committed
Add issue and PR templates, CONTRIBUTING.md
1 parent 5137c75 commit 438ddbb

5 files changed

Lines changed: 207 additions & 0 deletions

File tree

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Report a bug
2+
description: Let us know so we can fix it!
3+
labels: ["needs triage", "bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping us improve Cesium for Unity!
9+
10+
First, check if the issue already exists in the [issues](https://github.com/CesiumGS/cesium-unity/issues) page. If it does, please leave a **comment** on the existing issue instead.
11+
12+
Otherwise, if you can't find a similar issue, describe what is happening using the text fields below.
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: What happened?
17+
description: Also tell us, what did you expect to happen?
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: environment
22+
attributes:
23+
label: Environment
24+
description: What environment are you experiencing this issue in?
25+
value: |
26+
Cesium for Unity version:
27+
Unity Editor Version:
28+
Operating System:
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: repro
33+
attributes:
34+
label: Reproduction steps
35+
description: "How do you trigger this bug? Please walk us through it step by step, starting from either a blank project or the Cesium for Unity Samples. (We can triage bugs much faster when we have these steps.)"
36+
value: |
37+
1.
38+
2.
39+
3.
40+
...
41+
validations:
42+
required: false
43+
- type: textarea
44+
id: evidence
45+
attributes:
46+
label: Supporting evidence
47+
description: Providing screenshots, videos, or GIFs of the issue helps us a lot, especially for visual bugs. If there were any error messages or logs in the console, please include those too.
48+
validations:
49+
required: false
50+
- type: markdown
51+
attributes:
52+
value: |
53+
If you can also contribute a fix, we'd absolutely appreciate it! Fixing a bug in Cesium for Unity often means fixing a bug for numerous applications and end users. Check out the contributor guide to get started: [CONTRIBUTING.md](https://github.com/CesiumGS/cesium-unity/tree/main/CONTRIBUTING.md)
54+
55+
Let us know you're working on it, and we'd be happy to provide advice and feedback.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Ask a question
4+
url: https://community.cesium.com/c/cesium-for-unity/13
5+
about: Please use the community forum for general questions. The Cesium team and community actively monitor it and love to see what people are working on! We reserve GitHub for confirmed bug reports and feature requests.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Request a feature
2+
description: New ideas & improvements to Cesium for Unity are always welcome.
3+
labels: ["needs triage", "enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping us improve Cesium for Unity!
9+
10+
When suggesting an idea, give examples of the intended use case. Features that benefit the wider community are more likely to be prioritized.
11+
- type: textarea
12+
id: new-feature
13+
attributes:
14+
label: Feature
15+
validations:
16+
required: true
17+
- type: markdown
18+
attributes:
19+
value: |
20+
The best way to get your ideas into Cesium for Unity is to help us! We love contributions and are always happy to be provide feedback and advice. Check out the contributor guide to get started: [CONTRIBUTING.md](https://github.com/CesiumGS/cesium-unity/tree/main/CONTRIBUTING.md)

.github/pull_request_template.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!--
2+
Thanks for the Pull Request!
3+
4+
Please review the [Contributor Guide](https://cesium.com/learn/cesium-unity/ref-doc/contributing-unity.html) before opening your first Pull Request.
5+
6+
To ensure your Pull Request is reviewed and accepted quickly, please refer to our [Pull Request Guidelines](https://cesium.com/learn/cesium-unity/ref-doc/contributing-unity.html#opening-a-pull-request).
7+
8+
-->
9+
10+
## Description
11+
12+
<!-- Summarize the pull request. -- >
13+
14+
< !-- Provide context for the reviewer to understand the pull request. Include what changes were made and why. -->
15+
16+
<!-- Include screenshots if appropriate. -->
17+
18+
## Issue number or link
19+
20+
<!-- If it fixes an open issue, link to the issue here -->
21+
22+
<!-- Consider: If suggesting a new feature or change, discuss it in an issue first. -->
23+
24+
## Author checklist
25+
26+
- [ ] I have submitted a [Contributor License Agreement](https://github.com/CesiumGS/community/tree/main/CLAs) (only needed once).
27+
- [ ] I have done a full self-review of my code.
28+
- [ ] I have updated `CHANGES.md` with a short summary of my change (for user-facing changes).
29+
- [ ] I have added or updated unit tests to ensure consistent code coverage as necessary.
30+
- [ ] I have updated the documentation as necessary.
31+
32+
## Remaining Tasks
33+
34+
<!-- Are there any remaining tasks to do or blocking questions to answer before we can merge this? -->
35+
36+
<!-- If so, please convert this to a draft PR and let us know how we can help. Otherwise, you may remove this section. -->
37+
38+
## Testing plan
39+
40+
<!-- Describe in detail how you tested your changes. If this fixes a bug, list the steps to reproduce the original issue. -->
41+
42+
<!-- Include links to any required data or screenshots. Mention any edge cases such as user error, invalid data, etc. -->

CONTRIBUTING.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributing {#contributing-unity}
2+
3+
Thanks for contributing to Cesium for Unity!
4+
5+
<!--!
6+
[TOC]
7+
-->
8+
9+
Here are the guidelines that we use for all contributions to this project:
10+
11+
- [Submitting an issue](#submitting-an-issue)
12+
- [Getting started contributing](#getting-started-contributing)
13+
- [Opening a pull request](#opening-a-pull-request)
14+
15+
To ensure an inclusive community, contributors and users in the Cesium community should follow the [code of conduct](https://github.com/CesiumGS/community/tree/main/CODE_OF_CONDUCT.md).
16+
17+
# Submitting an Issue {#submitting-an-issue}
18+
19+
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.
20+
21+
If you think you've found a bug in Cesium for Unity, first search the existing [issues](https://github.com/CesiumGS/cesium-unity/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.
22+
23+
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:
24+
25+
- What version of Cesium for Unity were you using? Do other versions have the same issue?
26+
- What version of Unity Editor were you using?
27+
- What is your operating system and version, and your video card? Are they up-to-date? Is the issue specific to one of them?
28+
- Can the issue be reproduced in the [Cesium for Unity Samples](https://github.com/CesiumGS/cesium-unity-samples)?
29+
- Does the issue occur in Edit mode? In Play Mode? Both?
30+
- What [render pipeline](https://docs.unity3d.com/6000.1/Documentation/Manual/render-pipelines-overview.html) is your Unity project using? Built-in, URP, or HDRP?
31+
- Are there any error messages in the console? Any stack traces or logs? Please include them if so.
32+
- Share a screenshot, video or animated `.gif` if appropriate. Screenshots are particularly useful for exceptions and rendering artifacts.
33+
- Link to threads on the [Cesium community forum](https://community.cesium.com/) if this was discussed on there.
34+
- Include step-by-step instructions for us to reproduce the issue from scratch.
35+
- 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.
36+
37+
**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 Unity Samples](https://github.com/CesiumGS/cesium-unity-samples) or from a blank project. We will only request your Unity project and/or data as a last resort.
38+
39+
# Getting Started Contributing {#getting-started-contributing}
40+
41+
Everyone is welcome to contribute to Cesium for Unity!
42+
43+
In addition to contributing code, we appreciate many types of contributions:
44+
45+
- Being active on the [Cesium community forum](https://community.cesium.com/) by answering questions and providing input on Cesium's direction.
46+
- Showcasing your Cesium for Unity apps on [Cesium blog](https://cesium.com/blog/categories/userstories/). Contact us at hello@cesium.com.
47+
- Writing tutorials, creating examples, and improving the reference documentation. See the issues labeled [documentation](https://github.com/CesiumGS/cesium-unity/labels/documentation).
48+
- Submitting issues as [described above](#submitting-an-issue).
49+
- Triaging issues. Browse the [issues](https://github.com/CesiumGS/cesium-unity/issues) and comment on issues that are no longer reproducible or on issues for which you have additional information.
50+
51+
For ideas for Cesium for Unity code contributions, see:
52+
53+
- issues labeled [`good first issue`](https://github.com/CesiumGS/cesium-unity/labels/good%20first%20issue),
54+
- issues labeled [`low hanging fruit`](https://github.com/CesiumGS/cesium-unity/labels/low%20hanging%20fruit), and
55+
- issues labeled [`enhancement`](https://github.com/CesiumGS/cesium-unity/labels/enhancement).
56+
57+
See [Developer Setup](https://cesium.com/learn/cesium-unity/ref-doc/developer-setup.html) for how to build and run Cesium for Unity.
58+
59+
Always feel free to introduce yourself on the [Cesium community forum](https://community.cesium.com/) to brainstorm ideas and ask for guidance.
60+
61+
# Opening a Pull Request {#opening-a-pull-request}
62+
63+
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.
64+
65+
> If you plan to make a major change, please start a new thread on the [Cesium community forum](https://community.cesium.com/) first. Pull requests for small features and bug fixes can generally just be opened without discussion on the forum.
66+
67+
## Contributor License Agreement (CLA)
68+
69+
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).
70+
71+
## Pull Request Guidelines
72+
73+
Our code is our lifeblood so maintaining Cesium's high code quality is important to us.
74+
75+
- For an overview of our workflow see [github pull request workflows](https://cesium.com/blog/2013/10/08/github-pull-request-workflows/).
76+
- Pull request tips
77+
- After you open a pull request, one or more Cesium teammates will review your pull request.
78+
- 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-unity/issues/1)). Likewise, if your pull request fixes an issue reported on the Cesium forum, include a link to the thread.
79+
- If your pull request needs additional work, include a [task list](https://github.com/blog/1375%0A-task-lists-in-gfm-issues-pulls-comments).
80+
- 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.
81+
- Verify that your code conforms to our [Style Guide](https://cesium.com/learn/cesium-native/ref-doc/style-guide.html).
82+
83+
## Code of Conduct
84+
85+
To ensure an inclusive community, contributors and users in the Cesium community should follow the [code of conduct](https://github.com/CesiumGS/community/tree/main/CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)