search

hajimehoshi / ebiten

Ebitengine - A dead simple 2D game engine for Go
https://ebitengine.org
Apache License 2.0
10.52k stars 641 forks source link

examples: rename `examples` to `example` #2770

Open hajimehoshi opened 10 months ago

hajimehoshi commented 10 months ago

Operating System

What feature would you like to be added?

I am not 100% sure, but this seems more conventional

As this is a breaking change, I'd do this in v3.

Why is this needed?

No response

tinne26 commented 10 months ago

To be honest, the only consensus for big projects seems to be externalizing the examples, rather than using example or examples. For each repository using example, you can find another using examples. Here are some... ehem... examples:

Even some well-known members of the Golang community use examples instead of example:

The highly criticized https://github.com/golang-standards/project-layout also uses examples.

Perhaps you are right that example is slightly more "official", but it's unclear and it seems like an unnecessary change in practice. Externalizing examples directly on ebitengine/examples may be more pertinent in the future.

hajimehoshi commented 10 months ago

Even some well-known members of the Golang community use examples instead of example:

Huh, interesting

The highly criticized https://github.com/golang-standards/project-layout also uses examples.

This might indicate we should go in the opposite direction 😁

Perhaps you are right that example is slightly more "official", but it's unclear and it seems like an unnecessary change in practice. Externalizing examples directly on ebitengine/examples may be more pertinent in the future.

I didn't say in this issue, but I plan to move github.com/hajimehoshi/ebiten/v2 to github.com/ebitengine/??/v3, so I thought this is a good chance to change the name.

hajimehoshi commented 9 months ago

Another example's example: https://github.com/go-gl/example