Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up root of /src directory #663

Open
reefdog opened this issue Apr 3, 2024 · 3 comments
Open

Clean up root of /src directory #663

reefdog opened this issue Apr 3, 2024 · 3 comments

Comments

@reefdog
Copy link
Contributor

reefdog commented Apr 3, 2024

We have a handful of files at the root of /src that should probably be organized to sub-directories. E.g., map-proposals.ts (and its testfile) should go in /src/utils.

Let's do a pass over that on a rainy day.

@slifty
Copy link
Member

slifty commented Apr 10, 2024

@reefdog just for some context there was a local MO to avoid a generic /utils directory, with the idea being that it becomes an antipattern / a disorganized cluster of otherwise unrelated functionality, and it would be better to try to keep things in well-named groups, either as root level files OR (as things expand) in folders.

This is why in /service we don't have a utils directory but we DO have a series of named folders and a few root level code files (e.g. logger is a root level concept).

I'm not actually trying to strongly advocate against a utils though the merits of the idea seemed strong enough to at least give it a whirl at the time!

@reefdog
Copy link
Contributor Author

reefdog commented Apr 10, 2024

@slifty That's a good note. I do think something as specific as map-propposals.ts doesn't need to be at src/, but am definitely open to a finer organization than just utils/

@slifty
Copy link
Member

slifty commented Jul 11, 2024

Let's take this on (or mark it as complete if it's already taken on!)

Putting it in the Phase 3 project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Later
Development

No branches or pull requests

2 participants