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

Explicit public surface definition #1533

Open
sobolk opened this issue May 16, 2024 · 1 comment
Open

Explicit public surface definition #1533

sobolk opened this issue May 16, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation feature-request New feature or request tech-debt Refactors, unsavory workarounds or other technical decisions that should be revisited later

Comments

@sobolk
Copy link
Member

sobolk commented May 16, 2024

We should define and document our public contract. So that customers know how our public surface is evolved and for us to guide that evolution.

We should define and publish:

  1. What API changes are allowed in what package.
  2. How do we mark APIs as public, "public but for internal purpose", experimental etc.
  3. Which stateful parts, like deployed resources are considered contract and which not. For example, CFN outputs.

In addition, we should implement automated checks to enforce that publicly facing elements are properly documented and annotated.

@sobolk sobolk added documentation Improvements or additions to documentation feature-request New feature or request tech-debt Refactors, unsavory workarounds or other technical decisions that should be revisited later p2 labels May 16, 2024
@redjonzaci
Copy link

can i help?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature-request New feature or request tech-debt Refactors, unsavory workarounds or other technical decisions that should be revisited later
Projects
None yet
Development

No branches or pull requests

3 participants