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

Guidance on what counts as a non-user visable change #11

Open
oxinabox opened this issue Oct 26, 2020 · 2 comments
Open

Guidance on what counts as a non-user visable change #11

oxinabox opened this issue Oct 26, 2020 · 2 comments

Comments

@oxinabox
Copy link
Contributor

I think it might be useful to define what a non-user visible change is.
Possibly with reference to making releases.
In a sense perhaps a non-user visible change is a 3rd category, like bug-fix or feature.

When I say non-user-visible change I mean one of:

  • Refactoring to change internal structure (but not the public API)
  • Updating a comment
  • renaming a variable
  • Fixing a mistake in the tests

Some things sound similar like:

  • Performance improvements
  • updating documentation.

But are not.

Was reminded of this in
JuliaDiff/ChainRules.jl#296 (comment)

@ChrisRackauckas
Copy link
Member

Yes, good point. I'd also add a big one: changes to arguments in non-public APIs. It's really the definition of non-public: you can break it at will, and it's not a breaking change.

@oxinabox
Copy link
Contributor Author

oxinabox commented Oct 26, 2020

Yep, basically a special case of refactoring that is worth calling out to be clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants