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

Design of a collect service #92

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Design of a collect service #92

merged 3 commits into from
Jan 23, 2025

Conversation

jadudm
Copy link
Contributor

@jadudm jadudm commented Jan 22, 2025

We prefer smaller PRs that merge more often.

Haiku-length summary

Documentation
Better in than out, I say
The repo tracks all

Additional details

The ticket for the collect service captured a lot of the design thinking for this service. After a discussion with @IsabelLaurenceau , I wrote it up and put it in the docs. It is assumed that as we work on this (and as @luisgmetzger dives in) that questions will arise/edits will be made/etc. But, for now, it provides a concrete starting point for implementation and discussion.

The checklist is mostly empty,a s this is a strictly documentation commit. Related to #64.

PR Checklist: Submitter

  • Link to an issue if possible. If there’s no issue, describe what your branch does. Even if there is an issue, a brief description in the PR is still useful.
  • List any special steps reviewers have to follow to test the PR. For example, adding a local environment variable, creating a local test file, etc.
  • For extra credit, submit a screen recording like this one.
  • Make sure you’ve merged main into your branch shortly before creating the PR. (You should also be merging main into your branch regularly during development.)
  • Make sure that whatever feature you’re adding has tests that cover the feature. This includes test coverage to make sure that the previous workflow still works, if applicable.
  • Make sure the E2E tests pass.
  • Do manual testing locally.
    • If that’s not applicable for some reason, check this box.
  • Once a PR is merged, keep an eye on it until it’s deployed to dev, and do enough testing on dev to verify that it deployed successfully, the feature works as expected, and the happy path for the broad feature area still works.

PR Checklist: Reviewer

  • Pull the branch to your local environment and run make macup ; make e2e" (FIXME)
  • Manually test out the changes locally
    • Check this box if not applicable in this case.
  • Check that the PR has appropriate tests.

The larger the PR, the stricter we should be about these points.

This provides an architectural overview of the `collect` service to help
design the implementation.

To be updated as the implementation proceeds.
@IsabelLaurenceau IsabelLaurenceau self-requested a review January 23, 2025 12:56
@IsabelLaurenceau IsabelLaurenceau added this pull request to the merge queue Jan 23, 2025
Merged via the queue into main with commit 92a6257 Jan 23, 2025
3 checks passed
@jadudm jadudm deleted the jadudm/collect-design branch January 25, 2025 18:45
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.

2 participants