https://github.com/aip-dev/google.aip.dev

API Improvement Proposals. https://aip.dev/
https://github.com/aip-dev/google.aip.dev

Last synced: about 1 month ago
JSON representation

API Improvement Proposals. https://aip.dev/

• Host: GitHub
• URL: https://github.com/aip-dev/google.aip.dev
• Owner: aip-dev
• License: other
• Created: 2019-03-20T00:40:59.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T10:57:32.000Z (6 months ago)
• Last Synced: 2024-05-22T15:18:56.850Z (6 months ago)
• Language: Shell
• Size: 27.4 MB
• Stars: 1,002
• Watchers: 58
• Forks: 445
• Open Issues: 322
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• jimsghstars - aip-dev/google.aip.dev - API Improvement Proposals. https://aip.dev/ (Shell)

README

        
# API Improvement Proposals

**TL;DR:** AIPs are lots of documents on how Google does APIs.

## Overview

AIP stands for **API Improvement Proposal**, which is a design document

providing high-level, concise documentation for API development. The goal is

for these documents to serve as the source of truth for API-related

documentation at Google and the way API teams discuss and come to consensus on

API guidance. The program is named and styled after Python's enhancement

proposals (PEPs) which have seemed to work pretty well over the years.

### Specific areas inside Google

While much of the API-related guidance is general and spans across all the

different products at Google, we've found that some teams working in different

areas may have different customs, styles, or guidance. To accommodate these

historical differences, we've provided separate blocks of numbers for those

areas where they might override or extend the more general guidance.

## Getting started

### New to AIPs?

If you're **new to AIPs**, check out the [Frequently Asked Questions][] which

answer some common questions about how AIPs work and what you need to know.

### Want to use this in your company?

If you like what you see and **want to adopt the general AIPs for your

organization**, check out our guide on [Adopting AIPs in your company][]. This

guide walks you through how to start using AIPs and write your own guidance

specific to your organization.

### Have an idea for an AIP?

If you **have an idea for an AIP that isn't written yet** (yes, there are

plenty!) check out [Contributing to the project][] to see how you can write

AIPs for others to follow.

[frequently asked questions]: https://google.aip.dev/faq

[adopting aips in your company]: https://google.aip.dev/adopting

[contributing to the project]: ./CONTRIBUTING.md

## License

Except as otherwise noted, the content of this repository is licensed under the

[Creative Commons Attribution 4.0 License][1], and code samples are licensed

under the [Apache 2.0 License][2].

For the full text of each license, see [`LICENSE.md`](./LICENSE.md). For

additional details, see the developer.google.com [Site Policies][3].

[1]: https://creativecommons.org/licenses/by/4.0/

[2]: https://www.apache.org/licenses/LICENSE-2.0

[3]: https://developers.google.com/terms/site-policies