diff options
| author | Dan Moseley <danmose@microsoft.com> | 2020-03-02 21:29:10 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-02 21:29:10 +0300 |
| commit | 129ee5252757ec8bdfccf9b271ded36675570309 (patch) | |
| tree | 3618ec04e0bef55314f7d9a120a80bdb55342f12 /CONTRIBUTING.md | |
| parent | dc62dd61071c239401ef6397a4d7ae29161d10a7 (diff) | |
Update CONTRIBUTING.md (#33054)
Fixes https://github.com/dotnet/runtime/issues/910
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51116d4b192..065a190dc74 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ Please do not: * **DON'T** submit PRs that alter licensing related files or headers. If you believe there's a problem with them, file an issue and we'll be happy to discuss it. * **DON'T** add API additions without filing an issue and discussing with us first. See [API Review Process](docs/project/api-review-process.md). -## Managed Code Compatibility +## Breaking Changes Contributions must maintain [API signature](docs/coding-guidelines/breaking-changes.md#bucket-1-public-contract) and behavioral compatibility. Contributions that include [breaking changes](docs/coding-guidelines/breaking-changes.md) will be rejected. Please file an issue to discuss your idea or change if you believe that it may affect managed code compatibility. @@ -52,6 +52,7 @@ We use and recommend the following workflow: - Name the branch so that it clearly communicates your intentions, such as issue-123 or githubhandle-issue. - Branches are useful since they isolate your changes from incoming changes from upstream. They also enable you to create multiple PRs from the same fork. 4. Make and commit your changes to your branch. + - [Workflow Instructions](docs/workflow/README.md) explains how to build and test. - Please follow our [Commit Messages](#commit-messages) guidance. 5. Add new tests corresponding to your change, if applicable. 6. Build the repository with your changes. |