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

Organize files and clean up the project root #3828

Open
beechnut opened this issue Apr 26, 2024 · 0 comments
Open

Organize files and clean up the project root #3828

beechnut opened this issue Apr 26, 2024 · 0 comments

Comments

@beechnut
Copy link
Contributor

beechnut commented Apr 26, 2024

Our project root has a lot cluttering it up. I suspect we can organize and/or remove a good deal.

Here's a list of proposed changes, which may change upon further investigation.

Remember Chesterton's Fence! Some things are probably there for a reason. (But some things might actually be unused.)

  • Move binaries (serve*, build) to a bin/ folder or remove, and update invocations (e.g. in package.json)
  • Move non-binary (lol) scripts (docker_entrypoint.rb etc) to script/
  • Move linters / rc files (eslintrc, scss-lint) to a directory and update invocations to match.
  • Get rid of killport — there should be no need to kill ports
  • Remove check_images.rb (assuming it's safe to do so)
  • Move bonus configs to /config and update references to it in scripts
  • Change owner information — Greg Boone and other alums are listed as owner/team
  • Move favicon.ico. Guessing we don't need it there, because _site is where the published files live, and they're handled by favicon.yml.
  • 404.html looks important, but it's "for AccessLint purposes only". So, we probably don't need that in our project root either.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant