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.

Sign up for GitHub

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

Jump to bottom

Clarify core vs client package differences #200

Closed
AndrewSisley opened this issue Feb 9, 2022 · 1 comment
Closed

Clarify core vs client package differences #200

AndrewSisley opened this issue Feb 9, 2022 · 1 comment
Assignees
@AndrewSisley
Labels
area/db-system Related to the core system related components of the DB documentation Improvements or additions to documentation refactor This issue specific to or requires *notable* refactoring of existing codebases and components
Milestone
DefraDB v0.3

Comments

@AndrewSisley
Copy link
Contributor

Client for 'public' stuff, core for internal interfaces. Consider renaming some stuff and maybe add docs. Verify that all the types on the client interface functions are 'public'.

Suggest doing after #84 is merged.
@AndrewSisley AndrewSisley added documentation Improvements or additions to documentation area/db-system Related to the core system related components of the DB refactor This issue specific to or requires *notable* refactoring of existing codebases and components labels Feb 9, 2022
@AndrewSisley
Copy link
Contributor Author

I think we should have a proper discussion here, and hopefully formalize what is public and what is internal, and make that super clear within the codebase (including in the readme, package naming and go docs). We should then ensure we have obvious locations for integration tests that can cover any public interface.

@AndrewSisley AndrewSisley mentioned this issue Feb 11, 2022
Merged
@jsimnz jsimnz added this to the DefraDB v0.3 milestone Mar 1, 2022
@AndrewSisley AndrewSisley self-assigned this Mar 7, 2022
This was referenced Mar 7, 2022
Merged
Merged
Merged
Merged
This was referenced Mar 14, 2022
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AndrewSisley AndrewSisley

Labels
area/db-system Related to the core system related components of the DB documentation Improvements or additions to documentation refactor This issue specific to or requires *notable* refactoring of existing codebases and components
Projects
None yet
Milestone
DefraDB v0.3
Development

No branches or pull requests
2 participants
@jsimnz @AndrewSisley