Skip to content

Added APIReviewPrinciples document #59880

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Jan 15, 2025
Merged

Added APIReviewPrinciples document #59880

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8426c5f
Added APIReviewPrinciples document
mkArtakMSFT Jan 15, 2025
d8ff644
Update docs/APIReviewPrinciples.md
mkArtakMSFT Jan 15, 2025
35be482
Update docs/APIReviewProcess.md
mkArtakMSFT Jan 15, 2025
c5fffef
Update docs/APIReviewProcess.md
mkArtakMSFT Jan 15, 2025
d859110
Update docs/APIReviewProcess.md
mkArtakMSFT Jan 15, 2025
c2a517d
Update docs/APIReviewPrinciples.md
mkArtakMSFT Jan 15, 2025
e14830c
Update docs/APIReviewPrinciples.md
mkArtakMSFT Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/APIReviewPrinciples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## API Review Conventions and Principles

Check failure on line 1 in docs/APIReviewPrinciples.md

View workflow job for this annotation

GitHub Actions / lint 

First line in a file should be a top-level heading [Context: "## API Review Conventions and ..."]
Welcome to the API Review Conventions and Principles document for the dotnet/aspnetcore repository. This document serves as a comprehensive guide to the conventions and principles that our team has established over time. It is designed to encapsulate our collective knowledge and best practices, ensuring consistency and quality in our API design.

The primary goal of this document is to provide a reference for our team and contributors, helping them to understand and apply these principles when proposing new APIs. By adhering to these guidelines, we aim to foster a collaborative and informed API review process, ultimately enhancing the robustness and usability of our APIs.

We encourage you to refer to this document regularly and contribute to its evolution as we continue to refine our API review process.

## Principles
- Principle 1

## Conventions
- Convention 1
4 changes: 4 additions & 0 deletions docs/APIReviewProcess.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ The process is visualized in the below diagram:
1. The owner of the issue is now free to work on the implementation of the proposed API.
1. In case during implementation changes to the original proposal are required, the review should become obsolete and the process should start from the beginning.

## Learnings and growth

Over time the team will build up certain conventions and principles, that will be useful to establish for future API reviews too. To help with this, the [API Review Principles document](/APIReviewPrinciples.md) document will be used to store such principles and conventions, making them persistent over time. Eventually, it will grow into a good knowledge base that will also help newcomers to learn and be better prepared with designing their APIs.

## What Makes an issue/PR "ready-for-review"?

Before marking an issue as `api-ready-for-review`, make sure that the issue has the following:
Expand Down
Loading