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

Document module split in coding guidelines #11623

Open
mx-psi opened this issue Nov 8, 2024 · 0 comments
Open

Document module split in coding guidelines #11623

mx-psi opened this issue Nov 8, 2024 · 0 comments

Comments

@mx-psi
Copy link
Member

mx-psi commented Nov 8, 2024

On #11216 and others we have taken the approach of splitting existing modules into the parts that we intend to stabilize. This is not documented on our coding guidelines, but it should be!

We want to document the following:

  • What are the rough rules of thumb we use for deciding when to split into different modules vs different packages in the same module
  • What are some situations where we will always split modules (experimental stuff, testing helpers)
  • How to go about splitting a new module
    • Roughly, what changes are necessary
    • How to make sure there are no issues during the release because of the new modules
@mx-psi mx-psi self-assigned this Nov 8, 2024
@mx-psi mx-psi converted this from a draft issue Nov 8, 2024
@mx-psi mx-psi removed their assignment Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

1 participant