Runtime: Add API reviewing to the New Contributor Guide

Created on 20 May 2019  路  4Comments  路  Source: dotnet/runtime

https://github.com/dotnet/corefx/wiki/New-contributor-Docs#contributing-guide

The API review process is required for new APIs, but it is not mentioned at all on this page. This issue is a request for this information to be added somewhere in the new contributor guide.

https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/api-review-process.md

documentation easy up-for-grabs

All 4 comments

cc @karelz

I agree. However, rather than adding it to the wiki, we should add it to the main README or some other relevant md file. Maybe here: https://github.com/dotnet/corefx#how-to-engage-contribute-and-provide-feedback

I think it would also be useful to specifically break out how to format an API request. The document above covers the whole flow with that only mentioned briefly, with a link to an old issue as an example. We link to this very often and that would make it clearer.

-> Future as this is not must fix to ship.

The info is already captured on the WIki to some extent -- see e.g.: https://github.com/dotnet/corefx/wiki/Contributions#add--expose-api-in-corefx-net-core-only

Was this page helpful?
0 / 5 - 0 ratings

Related issues

omariom picture omariom  路  3Comments

yahorsi picture yahorsi  路  3Comments

sahithreddyk picture sahithreddyk  路  3Comments

jzabroski picture jzabroski  路  3Comments

GitAntoinee picture GitAntoinee  路  3Comments