Skip to content

Commit f7a7c19

Browse files
authored
Consolidate contributing guide (#20590)
* Consolidate contributing guide * Delete depreacated doc
1 parent 04828f3 commit f7a7c19

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,19 @@ This file provides general guidance for developers that are creating or updating
1111

1212
<!-- toc -->
1313

14-
- [Reporting problems](#reporting-problems)
14+
- [Reporting Problems](#reporting-problems)
1515
- [Avoid Breaking Changes](#avoid-breaking-changes)
1616
- [Design Guidelines](#design-guidelines)
17-
* [Exceptions for consistency within a service](#exceptions-for-consistency-within-a-service)
17+
* [Exceptions for Consistency within a Service](#exceptions-for-consistency-within-a-service)
1818
- [Coding Style](#coding-style)
1919
- [Directory Structure](#directory-structure)
2020
- [Pull Requests](#pull-requests)
21-
- [Pull Request checks](#pull-request-checks)
21+
- [Pull Request Checks](#pull-request-checks)
22+
- [Internal Contribution Guide](#internal-contribution-guide)
2223

2324
<!-- tocstop -->
2425

25-
## Reporting problems
26+
## Reporting Problems
2627

2728
If you discover a problem with a REST API document in this repo, feel free to [open an issue](https://github.com/Azure/azure-rest-api-specs/issues/new). But please do not report issues with service behavior / functionality in this repo.
2829

@@ -40,7 +41,7 @@ There is a [YouTube video series](https://www.youtube.com/watch?v=9Ng00IlBCtw) b
4041

4142
Another resource is the [Considerations for Service Design](https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md), which is an introduction to REST API design mainly for services that are just getting started.
4243

43-
### Exceptions for consistency within a service
44+
### Exceptions for Consistency within a Service
4445

4546
There are situations where a service has GA'd their API with design patterns that do not follow our guidelines and it would be a breaking change to adopt the API design in the guidelines.
4647
Because the first rule is to avoid breaking changes and because we want APIs to be consistent within a service, these design patterns are considered the standard for that service and should be followed in all subsequent (non-breaking) versions of that service's REST API.
@@ -70,7 +71,7 @@ If you want to contribute to the repository, follow these steps:
7071

7172
Microsoft employees can try out the experience at [OpenAPI Hub](https://aka.ms/openapihub) for [adding a new API version using OpenAPI Hub](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version).
7273

73-
## Pull Request checks
74+
## Pull Request Checks
7475

7576
Every PR in this repo will go through a series of PR checks, including:
7677

@@ -90,3 +91,10 @@ Every PR in this repo will go through a series of PR checks, including:
9091

9192
When any of these PR checks fails it will post a comment to the PR with links to information on how to resolve the problem.
9293
There is also the [CI Fix Guide](https://aka.ms/ci-fix) that describes how to fix common PR check failures.
94+
95+
## Internal Contribution Guide
96+
For management plane, please refer to https://aka.ms/rpguidelines;
97+
98+
For data-plane, please refer to [Guide to design and creation of Data Plane REST API and Client Libraries](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/591/Guide-to-design-and-creation-of-Data-Plane-REST-API-and-Client-Libraries);
99+
100+
For contribution access to spec repos, please refer to [Public repo vs. Private repo: To get write access](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/202/Overall-Process-of-Management-Plane-SDK-Onboarding?anchor=2.-create/update-the-openapi-specifications%2C-and-launch-swagger-pr-review)

documentation/ContributingGuidelines.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)