Project clean-up?

[paulloz]

I am wondering what should be done regarding project clean-up.
After a quick look through the repository, I saw that it was already quite messy: scripts and scenes in the sprite folder, files dropped at the root of the project, new folders not especially created in the right place...
I am afraid that it's going to quickly get less and less manageable.
On the one hand, I don't like the idea of setting a high standard for PRs, nor of rejecting PRs because they're a little messy. On the other hand, a completely unstructured project will without a doubt be overwhelming for newcomers and inexperienced developers.
Really interested in what y'all think about that. I guess there's some kind of balance to find here again?

[lazerwalker]

Also worth noting: someone created a new "ui" folder that now has 3 files in it. Since the "should we build the game in a PR?" logic is based on an explicit allow-list of file paths, the "ui" folder isn't included in that. Having standards around "this is where files should go!" will fix future additions from breaking the PR tooling.

[lazerwalker]

https://danger.systems/js/ is probably what we want here (have never used it, but creator is a friend). This will also allow us to functionally 'lock' (either warn or fail the PR) changes to risky files, and also potentially do things like remind people "hey, you added art assets, if you didn't make these yourself you should add a line to the ACKNOWLEDGEMENTS file"

[paulloz]

"hey, you added art assets, if you didn't make these yourself you should add a line to the ACKNOWLEDGEMENTS file"

This was another thing I wanted to talk about at some point.

[lazerwalker]

Would adding a nudge like that be enough, or is there some other aspect of it you wanted to talk about?

[iznaut]

this looks rad! any chance your friend would help us set it up 👀

[paulloz]

Would adding a nudge like that be enough, or is there some other aspect of it you wanted to talk about?

No, I think this is a good way of pointing out PRs that contain art, that seems perfect.

[lazerwalker]

Thinking through what checks we might want Danger to make before I start writing code:

• Congratulate someone for their first contribution
• Warn if they create/edit/delete any file in the project root
• Warn if they create a new directory in the project root
• Warn if they add any new files to any asset folders to add to ACKNOWLEDGEMENTS if appropriate
  • could: allow a set of folders, exclude a set of folders, or have a list of filetypes. If we prohibit new folder creation, an allowed list of folders makes sense
• If we have a strict folder structure, error if someone adds art assets outside of (non-root) art asset folders, or code files outside of (non-root) code folders
• If the PR doesn't currently cleanly merge, add a link to our FAQ page for how to fix merge conflicts
• If we start encouraging strict separation of features into their own scenes, warn on massive additions to a scene file ("are you sure you don't want to make a new scene for this feature?")

Curious what else we should have!

No pressure at all, but tagging in @orta in case this weird game experiment is interesting to you and you have any suggestions for how we should configure our Danger rules :)

[orta]

Heh, yeah, I saw this a while back and thought it was a cool idea - I think Danger could help automate a bunch of that!