Official untested examples?

Open

#53 opened on Jul 18, 2021 2 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 5/5
Estimated time: Over a week
Newbie friendliness: 25/100

Issue type: Documentation
Clarity: Needs clarification
Activity status: Stale
Tech stack: csharp, unity
Domain: documentation, game-dev

Research direction

Start with the repository README and the linked Unity Addressables how-to page to compare how these samples are presented and what guarantees are stated. The issue names no specific sample, file, or test; the requested outcome is an agreed policy and an up-to-date, working, verified set of examples.

Written by the indexing model from the issue text.

Description

I got to this repo from the Unity's official Addressables how-to page: https://unity.com/how-to/simplify-your-content-management-addressables, where it says:

Where can I learn more about Addressables?
If you want to use Addressables in your project, check out the Addressable Asset System documentation to learn how to get started. Read our blog post, check out the GitHub Samples, or join the discussions on forums.

Where the "GitHub Samples" link leads to this repo. And now I get to this repo and what do I see? The first paragraph of the readme literally says:

These are intended as jumping off points for your own development. These have not been tested, and are not guaranteed to work in your situation. They are just examples, to make some concepts easier to understand, or easier to replicate in your own project. Use at your own risk.

At the moment of writing this:

the last commit to the repo was made 3 months ago, which brought some small fix to one of the examples (https://github.com/Unity-Technologies/Addressables-Sample/commit/a824d027f2e365d9713af0d3fda23c0e59f188bc)
the previous commit before that was 11 months ago

The issue I have with all this is: what am I even implied to think about all this?! Why Unity does not take care to keep a working, verified, updated and guaranteed set of examples of one of its most important new features?

Am I supposed to use these examples, or does Unity know beforehand that they are suboptimal and do not reflect the way of doing things? Why are we left with these examples then? Why doesn't anyone at Unity make real examples that are tested, guaranteed to work and are not risky to use?

Can Unity please make sure that the examples for using its advertised technologies and features are up-to-date, working and are safe to refer to and use when looking to learn the aforementioned technologies?

Dominant language: C#
Stars: 1.5k
Forks: 303
PR merge metrics: No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.