diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 29abe23c0..c44e609d0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,45 +1,43 @@ --- -name: Bug report -about: Report a reproducible bug or regression. -title: '' +name: Bug Report +about: Report a bug to help us improve +title: '[Bug]: ' labels: 'bug' assignees: '' --- -**Describe the bug** +**Checked for duplicates** + +> Have you checked for duplicate issue tickets? -A clear and concise description of what the bug is. Before submitting, please remove unnecessary sections. +- Ex. Yes - I've already checked +- Ex. No - I haven't checked -**To Reproduce** +**Describe the bug** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. See error +> A clear and concise description of what the bug is. Plain-text snippets preferred but screenshots welcome. -***Code*** +Ex. When I did [...] action, I noticed [...] -```js -// code goes here -``` +**What did you expect?** -***Live example*** +> A clear and concise description of what you expect to happen -- +Ex. I expected [...] -**Expected behavior** +**Reproducible steps** -A clear and concise description of what you expected to happen. +> How would we reproduce this bug? Please walk us through it step by step. Plain-text snippets preferred but screenshots welcome. -**Screenshots** +1. +2. +3. -If applicable, add screenshots to help explain your problem (drag and drop the image). +**What is your environment?** -**Platform:** +> Include any computer hardware, operating system, framework, browser, time-of-day or other contextual information related to your issue - - Device: [Desktop, Mobile, ...] - - OS: [Windows, MacOS, Linux, Android, iOS, ...] - - Browser: [Chrome, Firefox, Safari, Edge, ...] - - Three.js version: [r???] - - Library version: [v???] +- Ex. Version of this software [e.g. vX.Y.Z] +- Ex. Operating System: [e.g. MacOSX with Docker Desktop vX.Y] +- ... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 4c5bd4f57..0b74a7aac 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,24 +1,34 @@ --- -name: Feature request -about: Suggest an idea for the project. -title: '' +name: New Feature +about: Suggest a new feature for us to implement +title: '[New Feature]: ' labels: 'enhancement' assignees: '' --- -**Is your feature request related to a problem? Please describe.** +**Checked for duplicates** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +> Have you checked for duplicate issue tickets? -**Describe the solution you'd like** +- Ex. Yes - I've already checked +- Ex. No - I haven't checked -A clear and concise description of what you want to happen. +**Alternatives considered** -**Describe alternatives you've considered** +> Have you considered alternative solutions to your feature request? -A clear and concise description of any alternative solutions or features you've considered. +- Ex. Yes - and alternatives don't suffice +- Ex. No - I haven't considered -**Additional context** +**Related problems** -Add any other context or screenshots about the feature request here. +> Is your feature request related to any problems? Please help us understand if so, including linking to any other issue tickets. + +Ex. I'm frustrated when [...] happens as documented in issue-XYZ + +**Describe the feature request** + +> A clear and concise description of your request. + +Ex. I need or want [...] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8ef73bbc1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +## Purpose +- Clear, easy-to-understand sentences outlining the purpose of the PR +## Proposed Changes +- [ADD] ... +- [CHANGE] ... +- [FIX] ... +## Issues +- Links to relevant issues +- Example: issue-XYZ +## Testing +- Provide some proof you've tested your changes +- Example: test results available at ... +- Example: tested on operating system ... diff --git a/CHANGELOG.md b/CHANGELOG.md index 02bfad5bc..fb130d611 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,305 +1,13 @@ # Changelog -All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) -and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +All notable changes to this project will be documented in this file. -## [0.3.21] - 2023.09.27 -### Added -- PNTSLoader: Support for `CONSTANT_RGBA`, `RGBA`, and `RGB565`. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [0.3.20] - 2023.06.26 -### Added -- `CesiumIonTilesRenderer` for more convenient use of the ion API. -- Frustum check support for OBB bounding volumes resulting in more than 35-45% fewer tiles loading and displaying in some cases when OBB bounding volumes are used. +## [X.Y.Z](https://github.com/NASA-AMMOS//releases/tag/X.Y.Z) - 2023-MM-DD -### Changed -- Consolidate bounding volumes into a common class to simplify implementation. -- Progressively process recursive tileset tiles preventing frame stalls of up to and over 100ms in some cases when many or large child tilesets were loaded. -- GoogleTilesRenderer.setLatLonToYUp now sets X+ to north and Z+ to east +### Added -### Fixed -- TilesRenderer.dispose function not working correctly. -- Type declaration file for constants. -- Raycasting not working correctly with "additive" tile refinement. +- -## [0.3.19] - 2023-06-13 -### Fixed -- Case sensitivity when dealing with file formats. -- Race condition when setting the transformation of gltf files. -- Case where internal tilesets were not disposed of properly when calling "dispose". -- Incorrect calculation of geometric error when spheres are available. -- Support for rayasting tiles with sphere bounding volumes. -- Add "constructLatLonFrame" and "getNorthernTangent" to Ellipsoid class. - -### Added -- `getBounds` and `getOrientedBounds` now return the AABB of a sphere if a tileset bounding box is not available. -- `GoogleTilesRenderer` for rendering Google's Photorealistic 3D Tiles - -## [0.3.18] - 2023-05-13 -### Added -- Support for DRACO-compressed PNTs files. - -## [0.3.17] - 2023-04-03 -### Fixed -- Case where raycasting could return an incorrect result when `firstHitOnly` was true. - -## [0.3.16] - 2022-11-11 -### Fixed -- Incorrect internal import statement. - -## [0.3.15] - 2022-11-09 -### Fixed -- Incorrect type definitions. - -### Added -- Export for glTF CESIUM_RTC extension. - -## [0.3.14] - 2022-09-26 -### Fixed -- Removed unused exports. - - -## [0.3.13] - 2022-09-26 -### Added -- Classes for Ellipsoid and EllipsoidRegion. -- DebugTilesRenderer: Added "displayRegionBounds" flag. -- Support for region bounds by converting the volumes into sphere and box bounds. - -## [0.3.12] - 2022-08-26 -### Fixed -- B3DMLoader: regression causing RTC_CENTER to not be respected. - -### Added -- Support for GLTFLoader Cesium_RTC extension. - -## [0.3.11] - 2022-07-04 -### Added -- Support for determining tile format based on magic bytes. - -### Fixed -- Small fixes to the `dispose` function. -- Re-add support for relative tile urls. - -## [0.3.10] - 2022-07-02 -### Added -- `resetFailedTiles` to enable retry tile downloads that failed. - -### Fixed -- Support for loading absolute URIs. -- Fix the application of the tile "up" axis adjustments. - -## [0.3.9] - 2022-03-28 -### Fixed -- Incorrect argument order to `FeatureTable.getData` - -## [0.3.7] - 2022-01-29 -### Fixed -- ensuring the working path included a "/" at the end when generating new file paths for the GLTFExtension and B3DM loaders. - -## [0.3.6] - 2022-01-29 -### Fixed -- "onPreprocessUrl" is now called for initial Tileset URL. - -## [0.3.5] - 2022-01-06 -### Added -- `TilesRenderer.onTileVisibilityChange` callback. -- Support for GLTF in tilesets (`3DTILES_content_gltf` extension). - -### Changed -- Improved type definitions. -- `PNTSLoader.parse` now returns a promise. -- All model loaders on inherit from a common type. - -## [0.3.4] - 2021-11-15 -### Added -- PriorityQueue: Added `schedulingCallback` to afford flexibility in job scheduling callback for scenarios where `requestAnimationFrame` will not work, such as with WebXR. - -### Fixed -- `autoDisableRendererCulling` incorrectly applying the inverse of the documented effect. -- Screen space error calculations now use the camera projectionMatrix rather than camera type to determine frustum type. - -## [0.3.3] - 2021-09-08 -### Added -- Support for embedded tileset / tile geometry URLs with hashes, search query parameters. - -## [0.3.2] - 2021-09-02 -### Changed -- DebugTilesRenderer: Bounding boxes now colored down the tree based on depth. -- DebugTilesRenderer: "MeshStandardMaterial" is now used instead of "MeshBasicMaterial" for debugging. -- TilesRenderer: add `getBoundingSphere` function. - -### Added -- DebugTilesRenderer: "RANDOM_NODE_COLOR" visualization setting. -- Names for various tile objects. -- DebugTilesRenderer: Added `getDebugColor` function for adjusing the debug visualization colors. -- Support for computing screen space error for tiles that had sphere bounds but no box bounds. -- DebugTilesRenderer: Added `customColorCallback` and `CUSTOM_COLOR` mode for custom debug coloring. - -### Fixed -- I3DMLoader: Fixed embedded absolute URLs not working correctly. -- TilesRenderer: "getBounds" function throwing an error if no bounding box is present on the tileset. - -## [0.3.1] - 2021-07-28 -### Fixed -- Case where tiles that were outside of the camera frustum would be loaded with a higher priority. -- Case where a single tiles renderer tiles would always be loaded with a higher priority. -- Case where bounding boxes with one dimension of 0 would not compute the distance to camera correctly. - -## [0.3.0] - 2021-07-24 -### Added -- `path-browserify` dependency explicitly rather than relying on implicit polyfills for `path` package. - -### Changed -- `PriorityQueue.priorityCallback` now takes two arguments. -- The default priority sort now accounts for most recently used tiles, screenspace error, and distance to the camera. -- `TilesRenderer.calculateError` no longer returns a value but is now expected to set `__error` and `__distanceToCamera` on the tile itself. - -### Fixed -- `TilesRendererBase.preprocessURL` types definition. - -## [0.2.11] - 2021-06-03 -### Fixed -- PNTS files incorrectly having a GLTF rotation adjustment applied. - -## [0.2.10] - 2021-04-15 -### Added -- `TilesRenderer.optimizeRaycast` option to disable overriding the raycast function of loaded tiles. - -### Changed -- Added "sideEffects: false" to package.json. - -### Fixed -- Bounding box visualization not displaying correctly with `DebugTilesRenderer` when the bounds have a width of 0 in one dimension. - -## [0.2.9] - 2021-03-03 -### Added -- `onLoadTileSet` to the typescript definitions file. - -### Fixed -- Feature table attributes like `RTC_CENTER` not being correctly applied to loaded tile geometry. -- `B3DMLoader.load` not correctly resolving with a model. - -### Changed -- String decoding to use `TextDecoder`. - -## [0.2.8] - 2021-02-26 -### Fixed -- Pass fetch options to B3DMLoader. -- Set working path for loaders from CMPTLoader, TilesRenderer callback. -- Adjust loader handler in examples and README to provide GLTFLoader directly. - -## [0.2.7] - 2021-02-09 -### Added -- Add warnings if unsupported feature semantics are detected for I3DM and PNTS files -- Support for I3DM rotation, scale features. - -### Fixed -- A case where I3DM instances could have an incorrect transformations by respecting existing Mesh transformations when converting them to InstancedMeshes. - -### Changed -- Make CMPTLoader group child order consistent between loads. - -## [0.2.6] - 2021-02-03 -### Fixed -- I3DM files not correctly loading external gltf files. - -## [0.2.5] - 2021-01-17 -### Fixed -- Incorrect use of `multiply` when computing world transformations resulting in incorrect positioning of tiles when non identity transformations are used. - -## [0.2.4] - 2021-01-16 -### Fixed -- Feature and Batch Tables unnecessarily retaining full file buffer references. - -## [0.2.3] - 2020-12-30 -### Added -- `getOrientedBounds` function to `TilesRenderer`. -- `preprocessURL` function to `TilesRenderer`. - -## [0.2.2] - 2020-12-23 -### Fixed -- Incorrectly removing the implicit y-up to z-up GTLF transformation. - -## [0.2.1] - 2020-12-15 -### Added -- Support for external tile sets. -- B3DM support for RTC_CENTER. - -### Fixed -- Add a readable message for when console.assert fails. -- Add url information to log when tile load fails. -- Jittering with I3DM files when instances are positioned at large scales. - -## [0.2.0] - 2020-12-02 -### Changed -- Compatible three.js version to v0.123.0. - -## [0.1.7] - 2020-11-09 -### Changed -- `PriorityQueue` to wait a frame to schedule new tasks instead of using `Promise.resolve` so tasks will only be started once per frame. - -## [0.1.6] - 2020-10-08 -### Added -- `batchTable` and `featureTable` fields onto loaded B3DM, I3DM, and PNTS scene objects directly. -- `stopAtEmptyTiles` which defaults to true so tilesets correctly stop traversal at empty tiles. - -### Changed -- Tileset traversal now correctly stops at empty tiles if they do no meet the SSE requirement. Previous behavior can be retained for now by settings `stopAtEmptyTiles` to `false`. - -### Fixed -- Typescript declaration files for `CMPT`, `I3DM`, and `PNTS` loaders. - -## [0.1.5] - 2020-08-21 -### Added - -- `manager` field to `TilesRenderer` to enable support for DRACO decompression. -- `TilesRenderer.onLoadTileSet` callback function. -- Support for "ADD" tile refinement. - -### Fixed - -- `CMPTLoader` not importing `I3DMLoader`. -- A case where if the tile at depth `maxDepth` was empty nothing would be rendered. -- A case where an error was thrown if a mid tile had no content. - -## [0.1.4] - 2020-07-17 -### Added - -- `TilesRenderer.dispose` function to completely dispose of all loaded geometry, materials, and textures in the scene when the renderer is no longer needed. -- `TilesRenderer.onDisposeModel` function which is called when a tile model is disposed of from the cache. - -### Fixed - -- Case where the url protocol was converted to use a single slash instead of two when loading a model. -- Corner case where an error was thrown if the tileset was dragged off screen out of camera view. - -## [0.1.3] - 2020-07-12 -### Added - -- Basic support for CMPT, PNTS, and I3DM file formats. -- `autoDisableRendererCulling` field to `TilesRenderer`. -- A count of the amount of failed tile content loads to `TilesRenderer.stats`. - -### Fixed - -- Failed tileset downloads being indefinitely retried. -- Tile content stats not being correctly updated if a tile failed to load. -- Not propagating image load errors. -- DebugTilesRenderer using a different color for every submesh in a tile. Now a single color is used for every submesh in a tile. -- Tiles not rendering if an empty tile is encountered. -- Child tiles not rendering if a parent tile content failed to load. - -### Changed - -- Improved `update` function performance by deferring LRUCache array update. - -## [0.1.2] - 2020-06-08 -### Changed - -- License text in README to remove unnecessary copy. - - -## [0.1.0] - 2020-05-29 - -- Initial release. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..211738d94 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,135 @@ + +# Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community administrators responsible for enforcement at +[@NikJPL (Aniwat.Nik.Sheurpukdi@jpl.nasa.gov)](https://github.com/NikJPL), +[@snnjpl (Shawn.N.Nguyen@jpl.nasa.gov)](https://github.com/snnjpl) or +[@sharimayer — Configuration Manager](https://github.com/sharimayer). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..643c39e45 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,329 @@ +# Contributing to 3DTilesRendererJS + +Thanks for taking the time to consider contributing! We very much appreciate your time and effort. This document outlines the many ways you can contribute to our project, and provides detailed guidance on best practices. We look forward to your help! + +## Prerequisites + +Before you begin contributing to our project, it'll be a good idea to ensure you've satisfied the below pre-requisites. + +### License + +Our project has our licensing terms, including rules governing redistribution, documented in our [LICENSE](LICENSE) file. Please take a look at that file and ensure you understand the terms. This will impact how we, or others, use your contributions. + +### Code of Conduct + +Our Code of Conduct helps facilitate a positive interaction environment for everyone involved with the team, and provides guidance on what to do if you experience problematic behavior. Read more in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and make sure you agree to its terms. + +### Developer Environment + +For patch contributions, see our [Developer Documentation](https://github.com/NASA-AMMOS/3DTilesRendererJS/wiki) for more details on how to set up your local environment, to best contribute to our project. + +At a minimum however to submit patches (if using Git), you'll want to ensure you have: +1. An account on the Version Control System our project uses (i.e. GitHub). +2. The Version Control System client (i.e. Git) installed on your local machine. +3. The ability to edit, build, and test our project on your local machine. Again, see our [README.md](README.md) or detailed developer guide for more details + +### Communication Channels + +Before contributing changes to our project, it's a great idea to be familiar with our communication channels and to socialize your potential contributions to get feedback early. This will help give you context for your contributions, no matter their form. + +Our communication channels are: +- [Issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) - a regularly monitored area to report issues with our software or propose changes +- [Discussion board](https://github.com/NASA-AMMOS/3DTilesRendererJS/discussions) - a permanently archived place to hold conversations related to our project, and to propose as well as show+tell topics to the contributor team. This resource can be searched for old discussions. + +## Our Development Process + +Our project integrates contributions from many people, and so we'd like to outline a process you can use to visualize how your contributions may be integrated if you provide something. + +```mermaid +flowchart TD + repo_proj[(Our Repository)]-->|Fork|repo_fork[(Your Forked Repository)] + repo_fork-->|Make|patch(Your Changes) + patch-->|Submit|pr(Pull Request) + pr==>|Approved|repo_proj + pr-->|Changes Requested|repo_fork +``` + +### Fork our Repository + +Forking our repository, as opposed to directly committing to a branch is the preferred way to propose changes. + +See [this GitHub guide](https://docs.github.com/en/get-started/quickstart/fork-a-repo) on forking for information specific to GitHub.com + +#### Find or File an Issue + +Make sure people are aware you're working on a patch! Check out our [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) and find an open issue you'd like to work against, or alternatively file a new issue and mention you're working on a patch. + +#### Choose the Right Branch to Fork + +Our project typically has the following branches available, make sure to fork either the default branch or a branch someone else already tagged with a particular issue ticket you're working with. +- `main` — release branch +- `develop` — optional default branch, used primarily for new code development + +### Make your Modifications + +Within your local development environment, this is the stage at which you'll propose your changes, and commit those changes back to version control. See the [README.md](README.md) or development guide for more specifics on what you'll need as prerequisites to setup your local development environment. + +#### Commit Messages + +Commit messages to version control should reference a ticket in their title / summary line: + +``` +Issue #248 - Show an example commit message title +``` + +This makes sure that tickets are updated on GitHub with references to commits that are related to them. + +Commit should always be atomic. Keep solutions isolated whenever possible. Filler commits such as "clean up white space" or "fix typo" should be merged together before making a pull request, and significant sub-feature branches should be [rebased](https://www.youtube.com/results?search_query=git+rebase) to preserve commit history. Please ensure your commit history is clean and meaningful! + +### Submit a Pull Request + +Pull requests are the core way our project will receive your patch contributions. Navigate to your branch on your own fork within the version control system, and submit a pull request or submit the patch text to our project. + +Please make sure to provide a meaningful text description to your pull requests, whenever submitted. Our pull-request template will be auto-generated for you when you create your pull-request. See the template [here](.github/PULL_REQUEST_TEMPLATE.md). + +**Working on your first Pull Request?** See guide: [How to Contribute to an Open Source Project on GitHub](https://kcd.im/pull-request) + +### Reviewing your Pull Request + +Reviewing pull-requests, or any kinds of proposed patch changes, is an art. That being said, we follow the following best practices: +- **Intent** - is the purpose of your pull-request clearly stated? +- **Solution** - is your pull-request doing what you want it to? +- **Correctness** - is your pull-request doing what you want it to *correctly*? +- **Small Patches** - is your patch of a level of complexity and brevity that it can actually be reviewed by a human being? Or is does it involve too much content for one pull request? +- **Coding best practices** - are you following best practices in the coding / contribution language being used? +- **Readability** - is your patch readable, and ultimately maintainable, by others? +- **Reproducibility** - is your patch reproducible by others? +- **Tests** - do you have or have conducted meaningful tests? + +## Ways to Contribute + +### ⚠️ Issue Tickets + +> *Do you like to talk about new features, changes, requests?* + +Issue tickets are a very simple way to get involved in our project. It also helps new contributors get an understanding of the project more comprehensively. This is a great place to get started with the project if you're not sure where to start. + +See our list of issues at: https://github.com/NASA-AMMOS/3DTilesRendererJS/issues + +#### Cleaning up Duplicate Issues + +Often we receive duplicate issues that can confuse project members on *which* issue ticket to hold conversations upon. + +Here's how you can help: +1. Scan the list of *open* issue tickets for duplicate titles, or internal wording +2. If you find duplicates, copy / paste the below message on the conversation thread of the issue ticket *that has less participants* involved + +``` +This is a duplicate issue. Please migrate conversations over to [issue-XYZ](hyperlink to issue) +``` + +#### Good First Issues + +Issue tickets can vary in complexity, and issues labeled with `good first issue` labels are often a great way to get started with the project as a newcomer. + +Take a look at our [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues), and filter by `good first issue` for issues that are low-complexity, and that will help you get familiar with our issue tracking and patch submission process. + +#### Suggesting New Issue Labels + +Labels within our [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) are a great way to quickly sort through tickets. The project may not yet have labels to cover the full variety of issue tickets. Take a look through our list of issues, and if you notice a set of issue tickets that seem similar but are not categorized with an existing label, go ahead submit a request within one of the issues you've looked at with the following text: + +``` +I've noticed several other issues that are of the same category as this issue. Shall we make a new label for these types of issues? +``` + +#### Submitting Bug Issues + +Resolving bugs is a priority for our project. We welcome bug reports. However, please make sure to do the following prior to submitting a bug report: +- **Check for duplicates** - there may be a bug report already describing your issue, so check the [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) first. + +Here's some guidance on submitting a bug issue: +1. Navigate to our [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) and file a new issue +2. Select a bug template (if available) for your issue + 1. Fill out the template fields to the best of your ability, including output snippets or screenshots where applicable +3. Follow the general guidelines below for extra information about your bug + 1. Include a code snippet if you have it showcasing the bug + 2. Provide reproducible steps of how to recreate the bug + 3. If the bug triggers an exception or error message, include the *full message* or *stacktrace* + 4. Provide information about your operating system and the version of our project you're using + +#### Submitting New Feature Issues + +We welcome new feature requests to help grow our project. However, please make sure to do the following prior to submitting a new feature request: +- **Check for duplicates** - there may be a new feature issue already describing your issue, so check the [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) first +- **Consider alternatives** - is your feature really needed? Or is there a feature within our project or with a third-party that may help you achieve what you want? + +Here's some guidance on submitting a new feature issue: +1. Navigate to our [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) and file a new issue +2. Select a new feature template (if available) for your issue + 1. Fill out the template fields to the best of your ability + +#### Submitting Security Vulnerability Issues + +Security vulnerabilities should **not** be filed to the regular issue tracking system. + +Report your security vulnerabilities to (see contact links): [@jl-0](https://github.com/jl-0) or [@sharimayer](https://github.com/sharimayer) + +Please be sure to: +* Indicate the severity of the vulnerability +* Provide any workarounds, if you know them +* Provide return-contact information to follow-up with you if needed + +#### Reviewing Pull Requests + +Reviewing others' contributions is a great way to learn about best practices in both contributions as well as software. + +Take a look at our [pull requests tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/pulls), and try the following options for providing a review: +1. Read the code / patch associated with the pull-request, and take note of any coding, bug, or documentation issues if found +2. Try to recreate the pull-request patch on your local machine, and report if it has issues with your system in particular +3. Scan over suggested feedback from other contributors, and provide feedback if necessary + +### 💻 Code + +⚠️ It's **highly** advised that you take a look at our [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) before considering any code contributions. Here's some guidelines: +1. Check if any duplicate issues exist that cover your code contribution idea / task, and add comments to those tickets with your thoughts. +2. If no duplicates exist, create a new issue ticket and get a conversation started before making code changes using our [communication channels](#communication-channels). + +Once you have a solid issue ticket in hand and are ready to work on code, you'll want to: +1. Ensure you have development [prerequisites](#prerequisites) cleared. +2. Have your [development environment](#developer-environment) set up properly. +3. Go through our [development process](#our-development-process), including proposing changes to our project. + +Some guidelines for code-specific contributions: +- **Do your homework** - read-up on necessary documentation, like `README.md`s, developer documentation, and pre-existing code to see the intention and context necessary to make your contribution a success. It's important to _communicate_ what you're working on through our project [communication channels](#communication-channels) and get buy-in from frequent contributors - this will help the project be more receptive to your contributions! +- **Ask questions** - its important to ask questions while you work on your contributions, to check-in with frequent contributors on the style and the set of expectations to make your code contribution work well with pre-existing project code. Use our [communication channels](#communication-channels) +- **Keep positive** - code contributions, by their nature, have direct impacts on the output and functionality of the project. Keep a positive spirit as your code is reviewed, and take it in stride if core contributors take time to review, give you suggestions for your code or respectfully decline your contribution. This is all part of the process for quality open source development. +- **Comments** - include *useful* comments throughout your code that explain the intention of a code block, not a step-by-step analysis. See our [inline code documentation](#inline-code-documentation) section for specifics. + + +### 📖 Documentation + +Documentation is the core way our users and contributors learn about the project. We place a high value on the quality, thoroughness, and readability of our documentation. Writing or editing documentation is an excellent way to contribute to our project without performing active coding. + +⚠️ It's **highly** advised that you take a look at our [issue-tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) before considering any documentation contributions. Here's some guidelines: +1. Check if any duplicate issues exist that cover your documentation contribution idea / task, and add comments to those tickets with your thoughts. +2. If no duplicates exist, create a new issue ticket and get a conversation started before making documentation changes. + +Some guidelines for documentation best practices (summarized from Google's [excellent documentation guide](https://google.github.io/styleguide/docguide/best_practices.html)): +- **Minimum viable docs** - don't do less documentation than your users / developers need, but also don't do more +- **Changed code = changed docs** - if your code has changed, remember to update your documentation +- **Delete old docs** - continually clean your documentation tree, and remove outdated docs regularly + +#### Documentation Organization + +The overall structure of our project documentation is as follows: +- Source-controlled documentation + - [README.md](README.md) - top-level information about how to run, build, and contribute to the project + - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - best practices and guidance on how to work well with other people in the project, and suggestions on dealing with interpersonal issues + - [CONTRIBUTING.md](CONTRIBUTING.md) - guidance on contributing to the project + - `*.java`, `*.py`, `*.sh`, etc. - inline documentation available inside code files +- Hosted documentation + - [Wiki Main-page](https://github.com/NASA-AMMOS/3DTilesRendererJS/wiki) +- Discussion Boards + - [Discussions](https://github.com/NASA-AMMOS/3DTilesRendererJS/discussions) + + + +For directions on contributing to our source-controlled documentation: +1. Ensure you have development [prerequisites](#prerequisites) cleared. +2. Have your [development environment](#developer-environment) set up properly. +3. Go through our [development process](#our-development-process), including proposing changes to our project. + + + +#### Writing Style + +To ensure documentation is readable and consistent by newcomers and experts alike, here are some suggestions on writing style for English: +- Use gender neutral pronouns (they/their/them) instead of he/she/his/her +- Avoid qualifiers that minimize the difficulty of a task at hand, e.g. avoid words like “easily”, “simply”, “just”, “merely”, “straightforward”, etc. Readers' expertise may not match your own, and qualifying complexity may deter some readers if the task does not match their level of experience. That being said, if a particular task is difficult or complex, do mention that. + +#### Common Wording + +Below are some commonly used words you'll want to leverage in your documentation contributions: +- **AMMOS** - Advanced Multi-Mission Operations System tool set. AMMOS is also the eponymous organization that sponsors this repository. +- **Docker** - Containerization service used to perform automated build, release and deployment. +- **GitHub** - one word, and capitalization of the 'G' and the 'H' +- **GitHub Actions** - Continuous Integration (CI) services that facilitate build automation + +#### Inline Code Documentation + +For language-specific guidance on code documentation, including style guides, see [Google's list of language style guides](https://google.github.io/styleguide/) for a variety of languages. + +Additionally, take a look at Google's recommendations on [inline code documentation](https://google.github.io/styleguide/docguide/best_practices.html#documentation-is-the-story-of-your-code) for best practices. + +#### Media + +Media, such as images, videos, sound files, etc., are an excellent way to explain documentation to a wider audience more easily. Include media in your contributions as often as possible. + +When including media into our version-control system, it is recommended to use formats such as: +- Diagrams: [Mermaid](https://mermaid-js.github.io/mermaid/#/) format +- Images: JPEG format +- Videos: H264 MPEG format +- Sounds: MP3 format + + +### ❓ Questions + +Answering questions is an excellent way to learn more about our project, as well as get better known in our project community. + +Here are just a few ways you can help answer questions for our project: +- Answer open questions in our [discussion forum](https://github.com/NASA-AMMOS/3DTilesRendererJS/discussions) +- Answer open questions mentioned in our [issue tracking system](https://github.com/NASA-AMMOS/3DTilesRendererJS/issues) + + +When answering questions, keep the following in mind: +- Be polite and friendly. See our [Code of Conduct](CODE_OF_CONDUCT.md) recommendations as you interact with others in the team. +- Repeat the specific question you are answering, followed by your suggestion. +- If suggesting code, repeat the line of code that needs to be altered, followed by your alteration +- Include any post-steps or checks to verify your answer can be reproduced + +### 🎨 Design + +Design files can help to guide new features and new areas of expansion for our project. We welcome these kinds of contributions. + +Here are just a few ways you can help provide design recommendations for our project: +- Create visual mockups or diagrams to increase usability of our project applications. This can apply to user interfaces, documentation structuring, or even code architecture diagrams. +- Conduct user research to understand user needs better. Save your findings within spreadsheets that the project team / contributors can review. +- Create art, such as logos or icons, to support the user experience for the project + +Each of the above can be contributed directly to repository code, and you should use our [development process](#our-development-process) to contribute your additions. + +### 🎟️ Meetups + +A great way to contribute towards our project goals is to socialize and encourage people to meet and learn more about each other. Consider ideas like: +- Propose workshops or meetups regarding some topic within our project +- Help point project contributors and community members to conferences and publications where they may socialize their unique innovations +- Schedule in-person or virtual happy-hours to help create a more social atmosphere within the project community + +For the above ideas, use our [communication channels](#communication-channels) to propose get-togethers. +