From 95678b96d3fbca67a3b4047c6b5789e413f2c8c2 Mon Sep 17 00:00:00 2001 From: Eunice Waweru <73849846+msewaweru@users.noreply.github.com> Date: Tue, 27 Jul 2021 10:41:52 +0300 Subject: [PATCH] Update the Readme file and added the contributing file which was missing --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b048011 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to Microsoft Azure Documentation + +Thank you for taking the time to contribute to the Microsoft Azure documentation. + +This guide covers some general topics related to contribution and refers to the [contributors guide](https://docs.microsoft.com/contribute) for more detailed explanations when required. + +## Code of Conduct + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/), or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +## How can I contribute? + +There are many ways to contribute to the documentation, review the sections below to find out which one is right for you. + +### Editing in GitHub + +Follow the guidance for [Quick edits to existing documents](https://docs.microsoft.com/contribute/#quick-edits-to-existing-documents) in our contributors guide. + +### Pull Request + +Review the guidance for [Pull Requests](https://docs.microsoft.com/contribute/how-to-write-workflows-major#pull-request-processing) in our contributors guide. diff --git a/README.md b/README.md index b18bac4..0201939 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,9 @@ Welcome to the open-source [documentation](https://docs.microsoft.com/azure) of Contributing to open source is more than just providing updates, it's also about letting us know when there is an issue. Read our [Contributing guidance](CONTRIBUTING.md) to find out more. +> [!IMPORTANT] +> New pull requests **MUST** always be created against the master branch which is the default branch in the main repository and not the live branch. PRs created against the live branch will not be accepted. + ### Prerequisites You've decided to contribute, that's great! To contribute to the documentation, you need a few tools.