diff options
| author | Michael Michael <michmike@users.noreply.github.com> | 2019-05-22 16:04:16 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-22 16:04:16 +0200 |
| commit | 3d158d1be5ac3570f7ca82ccb914312d398f3487 (patch) | |
| tree | be50faf98654425a177be9aab183a6a486b244b2 /sig-windows | |
| parent | 714c3647b919bafedccd97673e5e95edc82b541d (diff) | |
Update CONTRIBUTING.md
Diffstat (limited to 'sig-windows')
| -rw-r--r-- | sig-windows/CONTRIBUTING.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/sig-windows/CONTRIBUTING.md b/sig-windows/CONTRIBUTING.md index a31f282b..e3185edd 100644 --- a/sig-windows/CONTRIBUTING.md +++ b/sig-windows/CONTRIBUTING.md @@ -8,7 +8,8 @@ Contains a list of common resources when contributing in the effort to support W - [Build Prerequisites](#build-prerequisites) - [Building Kubernetes binaries for Windows](#building-kubernetes-binaries-for-windows) - [Updating the Node binaries](#updating-the-node-binaries) -- [Creating a PR](#creating-a-pr) +- [Creating a PR](#creating-a-pr) +- [API Considerations](#api-considerations) - [Running Tests](#running-tests) - [Reporting Issues and Feature Requests](#reporting-issues-and-feature-requests) - [Gathering Logs](#gathering-logs) @@ -75,6 +76,10 @@ The detailed steps here are based off an example PR on GitHub: [https://github.c 6. Deploy your own cluster, including Windows Nodes 7. Test Your Changes +## API Considerations + +If you modifying an API in the SIG-Windows codebase, make sure you are aware of the API [guidelines](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api_changes.md) and [conventions](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md) used in Kubernetes. This [document offers guidelines for API reviewers that API developers should always have in consideration](https://docs.google.com/document/d/1pkCYjr_OLCRUk2e606eMa2PEIwJdFHAfU5slXtBcKj8/edit). + ## Running Tests For the most up-to-date steps on how to build and run tests, please go to [https://github.com/kubernetes-sigs/windows-testing](https://github.com/kubernetes-sigs/windows-testing). It has everything you need to build and run tests, as well as links to the SIG-Windows configurations used on [TestGrid](https://testgrid.k8s.io/sig-windows). |