Skip to content

Latest commit

 

History

History
147 lines (103 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

147 lines (103 loc) · 4.46 KB
Raw

Contributing

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 [email protected] with any additional questions or comments.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  • Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.
  • Make your changes in a new git fork
  • Follow Code style conventions
  • Run the tests (and write new ones, if needed)
  • Commit your changes using a descriptive commit message
  • Push your fork to GitHub
  • In GitHub, create a pull request to the main branch of the repository
  • Ask a maintainer to review your PR and address any comments they might have

Setting up the development environment

Install the development dependencies:

python -m pip install -r requirements-dev.txt

Install the pre-commit hooks:

pre-commit install

Compile the JavaScript:

( cd ./app/frontend ; npm install ; npm run build )

Running unit tests

Run the tests:

python -m pytest

Check the coverage report to make sure your changes are covered.

python -m pytest --cov

Running E2E tests

Install Playwright browser dependencies:

playwright install --with-deps

Run the tests:

python -m pytest tests/e2e.py --tracing=retain-on-failure

When a failure happens, the trace zip will be saved in the test-results folder. You can view that using the Playwright CLI:

playwright show-trace test-results/<trace-zip>

You can also use the online trace viewer at https://trace.playwright.dev/

Code style

This codebase includes several languages: TypeScript, Python, Bicep, Powershell, and Bash. Code should follow the standard conventions of each language.

For Python, you can enforce the conventions using ruff and black.

Install the development dependencies:

python -m pip install -r requirements-dev.txt

Run ruff to lint a file:

python -m ruff <path-to-file>

Run black to format a file:

python -m black <path-to-file>

If you followed the steps above to install the pre-commit hooks, then you can just wait for those hooks to run ruff and black for you.

Adding new azd environment variables

When adding new azd environment variables, please remember to update:

  1. main.parameters.json
  2. appEnvVariables in main.bicep
  3. App Service's azure.yaml
  4. ADO pipeline.
  5. Github workflows

Adding new UI strings

When adding new UI strings, please remember to update all translations. For any translations that you generate with an AI tool, please indicate in the PR description which language's strings were AI-generated.

Here are community contributors that can review translations:

Language Contributor
Danish @EMjetrot
French @manekinekko
Japanese @bnodir
Norwegian @@jeannotdamoiseaux
Portugese @glaucia86
Spanish @miguelmsft
Turkish @mertcakdogan