search

BerriAI / reliableGPT

Get 100% uptime, reliability from OpenAI. Handle Rate Limit, Timeout, API, Keys Errors
MIT License
623 stars 33 forks source link

feat(improvements): add base improvements to the project #30

Closed grski closed 1 year ago

grski commented 1 year ago

… docs, formatting, example Makefile, CI/CD, pre-commit Hey guys, as per our talk.

While I do want the feature to get shipped, I have various concerns regarding the general quality of the code. Before proceeding to the implementation, I deemed it necessary to introduce some improvements in various areas, which include:

  1. env management
  2. docs
  3. formatting/styling
  4. ci/cd
  5. dependabot so on, so forth.

This is just for starters.

I'll get @hkorzeniewski working on this more.

grski commented 1 year ago

Before this one gets merged, you should take a look at: https://github.com/th33ngineers/reliableGPT/pull/1 It's where initial fixes for formatting got added.

Please take a look at both PRs and let me know if this is something you'd like to see introduced in the project or we shouldn't bother ;)

grski commented 1 year ago

@adamjanas good first open source contribution :)

grski commented 1 year ago

@ishaan-jaff do you think it's fine to approve & merge these changes? If yes we'd like to do so and move further

grski commented 1 year ago

Okay, just added a couple of things with @hkorzeniewski These changes above introduce:

  1. consistent naming of the files
  2. moved tests to one directory outside the code
  3. removed files that should not be committed like builds (next step add automatic build & deployment to ci/cd)
  4. CI/CD through github actions with automated linting and tests (some tests need fixing, fixed couple of them already). Linting/formatting also needs some love, we fixed what we could
  5. Makefile utility
  6. Dependabot config (updates the requirements automatically)
  7. fixed for the most part formatting issues
  8. added packages that were missing in poetry config but were needed to get this to work

It's a big one, I'm keen to hear your opinion.

New tools introduced: GitHub Actions, Make, black, ruff.