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

Add API Review Process Documentation #53396

Merged
merged 10 commits into from
May 27, 2021
Merged

Add API Review Process Documentation #53396

merged 10 commits into from
May 27, 2021

Conversation

333fred
Copy link
Member

@333fred 333fred commented May 13, 2021

We're currently working on making a more formal API review process for Roslyn. This PR adds documentation to the repo on how that process works, and the general expectations for how the process should work. Much of this documentation is copied from dotnet/runtime, and modified to fit the repo. Still to be done:

  • Get a board on apireviews.net/backlog (cc @terrajobst).
  • List areas and owners for the IDE layers (cc @jasonmalinowski and @JoeRobich).
  • Set up the email aliases and meeting schedules.
  • Add labels to the repo.
  • Add examples of a good API request (this may come later).
  • Broad messaging to the roslyn team.

We're currently working on making a more formal API review process for Roslyn. This PR adds documentation to the repo on how that process works, and the general expectations for how the process should work. Much of this documentation is copied from dotnet/runtime, and modified to fit the repo. Still to be done:

* [ ] Get a board on apireviews.net/backlog (cc @terrajobst).
* [ ] List areas and owners for the IDE layers (cc @jasonmalinowski and @JoeRobich).
* [ ] Set up the email aliases and meeting schedules.
* [ ] Add examples of a good API request (this may come later).
* [ ] Broad messaging to the roslyn team.
@333fred
Copy link
Member Author

333fred commented May 13, 2021

@jaredpar @jinujoseph @vatsalyaagrawal, please take a look at the process documentation and let me know if you think it's comprehensive enough, or any questions you have after. My intent is that anyone should be able to read this and have a good idea of what the process is.

@333fred
Copy link
Member Author

333fred commented May 13, 2021

Also our community ambassadors, @jnm2 @svick @alrz @YairHalberstadt @Youssef1313, please take a look at this process and let me know your thoughts/things you're confused by. What we'd generally be asking from you as part of this process is tagging the appropriate owner when issues are filed, and potentially pinging us on older issues that need attention.

docs/area-owners.md Outdated Show resolved Hide resolved
@YairHalberstadt
Copy link
Contributor

What should the process be for someone who wants an API to be added but isn't yet clear on the exact shape it would take?

Copy link
Member

@Youssef1313 Youssef1313 left a comment

Choose a reason for hiding this comment

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

This is awesome 🎉

@Youssef1313
Copy link
Member

What should the process be for someone who wants an API to be added but isn't yet clear on the exact shape it would take?

I think it's almost always easy for issue writer to at least have a basic suggested API shape, which later can be changed during review.

Copy link
Contributor

@jnm2 jnm2 left a comment

Choose a reason for hiding this comment

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

Love this! 🎉

.github/ISSUE_TEMPLATE/api-suggestion.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/api-suggestion.md Outdated Show resolved Hide resolved
docs/contributing/API Review Process.md Outdated Show resolved Hide resolved
docs/contributing/API Review Process.md Outdated Show resolved Hide resolved
docs/contributing/API Review Process.md Outdated Show resolved Hide resolved
docs/contributing/API Review Process.md Outdated Show resolved Hide resolved
Co-authored-by: Youssef Victor <youssefvictor00@gmail.com>
Co-authored-by: Joseph Musser <me@jnm2.com>
docs/contributing/API Review Process.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/api-suggestion.md Outdated Show resolved Hide resolved
@333fred
Copy link
Member Author

333fred commented May 19, 2021

What should the process be for someone who wants an API to be added but isn't yet clear on the exact shape it would take?

I talked a bit about my thoughts here, but ultimately I think we do need at least a sketch.

Co-authored-by: Youssef Victor <youssefvictor00@gmail.com>
@333fred 333fred marked this pull request as ready for review May 26, 2021 22:35
@333fred 333fred requested a review from a team as a code owner May 26, 2021 22:35
@333fred
Copy link
Member Author

333fred commented May 26, 2021

@dotnet/roslyn-api-owners for review.

@333fred 333fred merged commit d72f606 into dotnet:main May 27, 2021
@ghost ghost added this to the Next milestone May 27, 2021
@333fred 333fred deleted the api-review branch May 27, 2021 21:41
@RikkiGibson RikkiGibson modified the milestones: Next, 17.0.P2 Jun 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants