azure-sdk/CONTRIBUTING.md

Azure SDK Contribution Guide

The Azure SDK project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Azure SDK Blog Contributions

The Azure SDK Blog welcomes contributions related to the new Azure SDKs. Please reach out to us here azsdkblog@microsoft.com if you are interested in contributing a blog post.

Azure SDK GitHub Pages Site Contributions

Here's the general contribution process:

1. Fork this repo
2. Create a new branch
3. Commit your changes to that branch
4. Do a PR from your fork/branch to azure-sdk/main.

Codespaces

Codespaces is new technology that allows you to use a container as your development environment. This repo provides a Codespaces container which is supported by both GitHub Codespaces and VS Code Codespaces.

GitHub Codespaces

1. From the Azure SDK GitHub repo, click on the "Code -> Open with Codespaces" button.

2. Open a Terminal

3. Execute the following command and Ctrl+Click the link generated. A new window will open with the Azure SDK website.

   bundle exec jekyll serve
   

VS Code Codespaces

1. Install the VS Code Remote Extension Pack

2. When you open the Azure SDK repo in VS Code, it will prompt you to open the project in the Dev Container. If it does not prompt you, then hit CTRL+P, and select "Remote-Containers: Open Folder in Container..."

3. Open a Terminal

4. Press Ctrl+Shift+T or execute the following command and Ctrl+Click the link generated. A new window will open with the Azure SDK website.

   bundle exec jekyll serve
   

Full Local Setup

This site uses Jekyll and GitHub pages. Installation instructions can be found here: https://jekyllrb.com/docs/installation

Here's how to setup the site locally:

1. Install Ruby+DevKit 2.6 - Don't install 2.7, it doesn't work with this site.

   You can find complete installation instructions here: https://jekyllrb.com/docs/installation

2. Restart your machine

   You may need to restart your machine after installing Ruby.

3. Install Jekyll

   gem install jekyll bundler
   

4. Install Dependencies

   Run the following command from the root of the azure-sdk project.

   bundle install
   

5. Open a terminal and execute the following command to start the site:

   bundle exec jekyll serve
   

6. Open a browser to https://127.0.0.1:4000 to run the site.