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

Define the process for additions to the API #3069

Open
jkwatson opened this issue Mar 29, 2021 · 5 comments
Open

Define the process for additions to the API #3069

jkwatson opened this issue Mar 29, 2021 · 5 comments
Assignees
Labels
API API related issues documentation

Comments

@jkwatson
Copy link
Contributor

We should have a well-defined process for how to add things to our public APIs.

Some questions:

  • Do we require any API changes to start in an incubator module?
  • At what point do we require spec changes/clarifications before we will accept new APIs?
  • Do we require all maintainers to approve before merging?
@jkwatson jkwatson added API API related issues documentation labels Mar 29, 2021
@harshita19244
Copy link
Contributor

Hey, could you assign me this issue, I am interested to work on it.

@harshita19244
Copy link
Contributor

In order to make changes, should I send a pr to the README itself?

@jkwatson
Copy link
Contributor Author

In order to make changes, should I send a pr to the README itself?

Probably to the Contributing.md rather than the readme.

@harshita19244
Copy link
Contributor

#3082
I am unable to link the PR to the issue currently. Kindly check, I have made a change in the CONTRIBUTING.md that presently answers the third question.

@jkwatson
Copy link
Contributor Author

#3082
I am unable to link the PR to the issue currently. Kindly check, I have made a change in the CONTRIBUTING.md that presently answers the third question.

I think you are misunderstanding the goal of this issue. This is specifically about additions to our API surface, not changes to the code in general. API changes must be very carefully scrutinized because we will support them forever.

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

No branches or pull requests

2 participants