Skip to content

Make all packages internal #115

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

Merged
merged 1 commit into from
Dec 20, 2020
Merged

Make all packages internal #115

merged 1 commit into from
Dec 20, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Dec 17, 2020

The Go packages of this project were written solely for the use within the project. Making them internal avoids them
unintentionally becoming part of the public API, resulting in a greatly increased maintenance and support burden and
limitations on further development work.

It would be interesting to identify the components of the internal API that might be useful to others and expose them intentionally as they reach a state of relative stability. However, for now the API should be considered only the command line interface and the JSON report structure.

@per1234
Copy link
Contributor Author

per1234 commented Dec 17, 2020

The failure of the "Lint configuration files" workflow is expected and unrelated to the changes proposed in this PR. It will be fixed by #114

Copy link
Contributor

@silvanocerza silvanocerza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this, good idea.

The Go packages of this project were written solely for the use within the project. Making them internal avoids them
unintentionally becoming part of the public API, resulting in a greatly increased potential maintenance and support
burden and limitations on further development work. It would be interesting to identify the components of the internal
API that might be useful to others and expose them intentionally as they reach a state of relative stability. However,
for now the public API should be considered only the command line interface and the JSON report structure.
@per1234 per1234 merged commit 7a54ccf into main Dec 20, 2020
@per1234 per1234 deleted the per1234/internal branch December 20, 2020 06:10
@per1234 per1234 added topic: code Related to content of the project itself type: enhancement Proposed improvement labels Sep 29, 2021
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants