Skip to content

Latest commit

 

History

History
94 lines (69 loc) · 5.54 KB

CONTRIBUTING.md

File metadata and controls

94 lines (69 loc) · 5.54 KB
Raw

Instructions for Contributing Code

Please note that as of August 2023, signed commits are required for all contributions to this project. For more information on how to set up, see the GitHub Authentication verify commit signature documentation.

Contributing bug fixes and features

This 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.opensource.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., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Microsoft Teams is currently accepting contributions in the form of bug fixes and new features. Any submission must have an issue tracking it in the issue tracker that has been approved by the Teams AI team. Your pull request should include a link to the bug that you are fixing. If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort.

Legal

If your contribution is more than 15 lines of code, you will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.

Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.azure.com to sign digitally.

Contributing guide

Below are sections of information you may need when contributing to our repository.

Using local bits in JavaScript

At the time of writing, this repository does not have daily builds. To check the latest status of daily builds, please see Daily Builds information.

If making changes to our main package(s), (at time of writing, teams-ai is the only published package in this repo), it may be necessary to test samples using local bits. By default, all samples will use the latest published version of teams-ai. To run a sample using local bits, please do the following:

Using latest package changes in js samples

  1. Update the teamsapp.local.yml and comment out the step to run npm install.

    -  - uses: cli/runNpmCommand
-    name: install dependencies
-    with:
-      args: install --no-audit

  2. Do not run npm install or build in the sample root. Instead use yarn to hoist packages and use the latest changes from the teams-ai package.

    1. If not already installed, install yarn globally.
    2. Delete node_modules and package-lock.json from the sample, if applicable.

  3. Navigate to the root js folder.

  4. In the js directory, run yarn && yarn build to hoist and install all dependencies, plus build all packages (including the samples).

  5. To run/use a sample, open that sample in it's own VS Code instance e.g. code js/samples/path-to-sample.

  6. With the changes listed above, you will be able to run the sample using latest bits, even while using TTK. Further information on running the samples can be found within the sample README.md.

  7. Revert these changes before making commits or if you need to use the latest published package.

PR styling requirements

  1. All PRs must indicate what programming language they are for in the title with a prefix of [JS], [C#] [PY], or [repo].
  2. All PRs must be prepended with one of the following keywords:
    • 'bump' - indicates a change to the version number of the package
      • note: ':' was removed and 'Bump' (capitalized) allowed since dependabot automatically starts all PR titles with 'Bump'
    • 'chore:' - indicates a change to the build process or auxiliary tools
    • 'docs:' - indicates a change to the documentation
    • 'feat:' - indicates a new feature
    • 'fix:' - indicates a bug fix
    • 'port:' - indicates a port of a feature from another language
    • 'refactor:' - indicates a code change that neither fixes a bug nor adds a feature
  3. All PRs must have an associated work item link in the title and the body of the PR, unless the change is marked as #minor in the PR details.
    • e.g. [JS] feat: #999 Add new feature

The purpose of this is to allow for easier filtering when creating changelogs and release notes.