Skip to content

Repo refactoring #19

Description

@apdubs

Hello. I've been working on getting a parser for Linux and ran across ORBS and your repository. I've got the base program working, still trying to get overlays up on KDE.

However, this repo is far from best practices and is in need of serious refactoring.

These are only a few observations from looking through the repo's file tree:

  • MSI files are deployment artifacts and should never be included in the repository. These should be added to github releases (or another platform) and the code for each version can be held on a branch to rebuild the image if required
  • Need CI/CD tooling to build the project a make or justfile can add a lot of commands to reduce development and deployment friction
  • lots of miscellaneous images and errata are cluttering up the root directory
  • inconsistent naming conventions and directory structure
  • the repo isn't named orbs which is what the app is named! 😃

There's huge room for improvement refactoring that would allow the project to be updated and maintained with much less effort. I may be able to submit a PR in the near future with some changes if you're up for it.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions