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

Consider type local as the default interceptor type #403

Open
diego-aquino opened this issue Sep 10, 2024 · 3 comments
Open

Consider type local as the default interceptor type #403

diego-aquino opened this issue Sep 10, 2024 · 3 comments
Labels
feature New feature or request good first issue Good for newcomers
Milestone

Comments

@diego-aquino
Copy link
Member

We could simplify our API to consider type: 'local' by default when creating an interceptor, making type an optional parameter.

Pros:

  • Simpler to get started;
  • Less mental overhead of comparing local vs remote interceptors when just starting with Zimic;
  • Will work in most testing scenarios.

Cons:

  • Users might never realize that type: 'remote' exists

To help with the only con I see, we could improve our documentation to encourage starting with a local interceptor, without passing any type, and point to other pages explaining advanced use cases with local and remote interceptors.

@diego-aquino diego-aquino added support Support request or question documentation Improvements or additions to documentation feature New feature or request and removed support Support request or question labels Sep 10, 2024
@diego-aquino diego-aquino moved this to To do in Zimic Sep 10, 2024
@diego-aquino diego-aquino modified the milestones: v0.11.0, v0.12.0 Sep 10, 2024
@diego-aquino diego-aquino self-assigned this Sep 11, 2024
@emanamoura
Copy link
Contributor

I think it is a nice thing to do, this appears to me a good first contribution, is this task open to contribute ?

@diego-aquino diego-aquino changed the title Consider type local as the default interceptor type? Consider type local as the default interceptor type Oct 8, 2024
@diego-aquino diego-aquino added good first issue Good for newcomers and removed documentation Improvements or additions to documentation labels Oct 8, 2024
@diego-aquino
Copy link
Member Author

Hey, @emanamoura! Thanks for the interest in contributing to Zimic!

Right now, I'm working on the following issues to make it easier to contribute:

The most important one is the contributing guide showing how to fork and run the project, an overview of the packages and architecture, and our philosophies and guidelines. Would you like to wait for them before taking implementation tasks?

I expect to add the contributing guide and the issues/discussions templates by next week.


In the meantime, there are two tasks related to the documentation and the examples that may be good first issues too. Let me know if you are interested in working on them.

@emanamoura
Copy link
Contributor

Hi @diego-aquino , yes ! I can wait. Could I get #406 ?

@diego-aquino diego-aquino removed their assignment Nov 1, 2024
@diego-aquino diego-aquino modified the milestones: v0.12.0, v0.13.0 Nov 15, 2024
@diego-aquino diego-aquino modified the milestones: v0.12.0, v0.13.0 Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request good first issue Good for newcomers
Projects
Status: To do
Development

No branches or pull requests

2 participants