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

chore: Improve Makefile structure, add comments, add coral web make commands #868

Merged
merged 3 commits into from
Dec 9, 2024

Conversation

tianjing-li
Copy link
Collaborator

@tianjing-li tianjing-li commented Dec 5, 2024

Thank you for contributing to the Cohere Toolkit!

  • PR title: "area: description"

    • Where "area" is whichever of interface, frontend, model, tools, backend, etc. is being modified. Use "docs: ..." for purely docs changes, "infra: ..." for CI changes.
    • Example: "deployment: add Azure model option"
  • PR message: Delete this entire checklist and replace with

    • Description: a description of the change
    • Issue: the issue # it fixes, if applicable
    • Dependencies: any dependencies required for this change
  • Add tests and docs: Please include testing and documentation for your changes

  • Lint and test: Run make lint and make run-tests

AI Description

This pull request introduces several changes to the Makefile, primarily focused on enhancing the testing, linting, and database management processes. The changes are organised into sections for the backend and frontend, with the backend section being newly added.

Backend

  • Testing & Linting: The PR adds a new section for testing and linting, including commands for running unit tests, community tests, and integration tests. It also introduces commands for type checking (typecheck), linting (lint), and linting with automatic fixes (lint-fix).
  • Database Management: A new test-db command is added to stop, remove, and restart the test database.
  • Setup: The install command is introduced for installation with the dev option.

Frontend

  • Coral Web: The PR adds commands for formatting (format-coral), generating clients (generate-client-coral), installing (install-coral), and building (build-coral) the Coral Web interface.
  • Assistants Web: The format-web and build-web commands are moved from the backend to the frontend section, ensuring a clear separation of concerns.

@codecov-commenter
Copy link

codecov-commenter commented Dec 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.11%. Comparing base (a5892ca) to head (01629a1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #868   +/-   ##
=======================================
  Coverage   78.11%   78.11%           
=======================================
  Files         259      259           
  Lines       11114    11114           
=======================================
  Hits         8682     8682           
  Misses       2432     2432           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@malexw malexw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good changes!

I haven't reviewed the README recently, but are there any changes we should be making to the documentation now that we have some new commands in the Makefile here for people to use?

@tianjing-li tianjing-li merged commit f6befe6 into main Dec 9, 2024
6 of 7 checks passed
@tianjing-li tianjing-li deleted the add-coral-web-make branch December 9, 2024 18:36
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

Successfully merging this pull request may close these issues.

3 participants