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

discussion of stability for internal APIs #2030

Closed
trevnorris opened this issue Jun 22, 2015 · 5 comments
Closed

discussion of stability for internal APIs #2030

trevnorris opened this issue Jun 22, 2015 · 5 comments

Comments

@trevnorris
Copy link
Contributor

Filing for discussion in the next TSC meeting.

Ref: #2026 (and its linked threads)

Main point of discussion is: Do internal, but publicly exposed, APIs need to remain API stable across minor releases. As interpreted from the API Stability Policy here: https://github.com/nodejs/dev-policy#stability-policy

The hopeful outcome is to come to consensus on how to interpret that section, and file any changes the policy as necessary.

This issue is only a placeholder, and discussion on this topic has happened ad nauseam elsewhere. I do not intend further discussion to happen on this thread.

@Fishrock123
Copy link
Contributor

@nodejs/tsc It would be helpful if ya'll could give it a bit of a read-through beforehand.

@Fishrock123
Copy link
Contributor

I think I found the key bits in there:

(b) it is clear that the Implicit API being modified was originally intended for internal use as part of the underlying implementation (as opposed to being targeted at developers); or

&

That said, changes to any of the APIs should not be made lightly as there is currently no reliable means of determining in advance the impact any change may have on existing applications and modules. Collaborators must use their best judgement to determine whether any given change is "technically backwards incompatible but in practice should not be", then approach landing the change accordingly.

@cjihrig
Copy link
Contributor

cjihrig commented Jun 24, 2015

@trevnorris these might also be relevant:

nodejs/dev-policy#37
nodejs/dev-policy#50

@trevnorris
Copy link
Contributor Author

@cjihrig Thanks for the additional information.

Discussion was had and recorded in meeting notes.

@trevnorris
Copy link
Contributor Author

Link to meeting issue: #58

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

3 participants