Add a comment at the top of the lock file that explains how it's generated

[rcap107]

Problem description

The lock file is machine-build but should still be readable by humans. I think it would be useful to have a short comment at the top of the file that explains how the file is generated and when it's updated (new package releases/changes in the pixi.toml/pyproject.toml etc.).

I'm proposing this because I've had a few people come in and wonder what is that file and why does it add a bunch of changes to the diff. Basically, it's for devs/contributors that aren't deeply familiar with how the repo is structured and managed: they may make some change, and see this huge file that gets modified and don't know why it changed and how to deal with it.

[hunger]

I see merit in this idea, but it conflicts with our attempt to keep the file as small as possible.

I am not sure a not too oversized comment at the top of the file will help too much when people run into pixi.lock in git diff: The comment would probably not change, so it is unlikely to show up.

[rcap107]

I get what you're saying, but I think that the important information can be conveyed in a short message like "This file was generated by pixi according to the latest version of pixi.toml. Reference: https://pixi.prefix.dev/latest/workspace/lock_file/"

Either pixi.toml or pyproject.toml depending on what is being used.

I think it would be enough to tell people where to look for additional info if they do head pixi.lock or similar.