Ways to contribute

You can easily contribute to technical articles in the GitHub user interface. Either find the article in this repository, or visit the article on https://docs.microsoft.com/bot-framework and click the link in the article that goes to the GitHub source for the article.

If you are making substantial changes to an existing article, adding or changing images, or contributing a new article, you need to fork this repository, install Git Bash, Markdown Pad, and learn some git commands.

About your contributions to Bot Framework content

Minor corrections

Larger submissions

If you submit a pull request with new or significant changes to documentation and code examples, we'll send a comment in GitHub asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. We need you to complete the online form before we can accept your pull request.

The \articles folder contains the \media folder for root directory article media files, inside which are subfolders with the images for each article. The service folders contain a separate media folder for the articles within each service folder. The article image folders are named identically to the article file, minus the .md file extension.

Branches

We recommend that you create local working branches that target a specific scope of change. Each branch should be limited to a single concept/article both to streamline work flow and reduce the possibility of merge conflicts. The following efforts are of the appropriate scope for a new branch:

A new article (and associated images)

Spelling and grammar edits on an article.

Applying a single formatting change across a large set of articles (e.g. new copyright footer).

How to use markdown to format your topic

All the articles in this repository use GitHub flavored markdown. Here's a list of resources.

Article metadata

Article metadata enables certain functionalities, such as author attribution, contributor attribution, breadcrumbs, article descriptions, and SEO optimizations as well as reporting Microsoft uses to evaluate the performance of the content. So, the metadata is important! Here's the guidance for making sure your metadata is done right.

Labels

Automated labels are assigned to pull requests to help us manage the pull request workflow and to help let you know what's going on with your pull request:

Contribution License Agreement related

cla-not-required: The change is relatively minor and does not require that you sign a CLA.

cla-required: The scope of the change is relatively large and requires that you sign a CLA.

cla-signed: The contributor signed the CLA, so the pull request can now move forward for review.

Pillar labels: Labels such as PnP, Modern Apps, and TDC help categorize the pull requests by the internal organization that needs to review the pull request.

Change sent to author: The author has been notified of the pending pull request.