Azure-Samples / Azure-Samples/rag-postgres-openai-python

Acceptance criteria checklist (DoD)

Offen
#18 1 Kommentar 0 Reaktionen 1 zugewiesene Person Beansprucht von @anfibiacreativa Auf GitHub ansehen
Standardization
Vorherrschende Sprache
Python
Sterne
505
Forks
1.1k
Ø Merge
3 T. 13 Std.
Gemergte PRs (30 T.)
1

Beschreibung

The following checklist must be complete before a template is published.

# Repository Management

- [x] Standards compliant [readme.md](./readme.md) is in place
- [x] [License](https://github.com/Azure-Samples/azd-template-artifacts/blob/main/LICENSE.md) is in place. Make sure you choose the [correct license](https://www.microsoft.com/en-us/legal/intellectualproperty/open-source)
- [x] [Security guidelines](https://github.com/Azure-Samples/azd-template-artifacts/blob/main/SECURITY.md) are in place
- [x] [Contribution guidelines](https://github.com/Azure-Samples/azd-template-artifacts/blob/main/CONTRIBUTING.md) are in place
- [x] [Code of conduct](https://github.com/Azure-Samples/azd-template-artifacts/blob/main/.github/CODE_OF_CONDUCT.md) is in place
- [x] [Issue template](.github/ISSUE_TEMPLATE.md) is in place
- [x] #19
- [x] Repo description is in place, describing the use case and technologies used in the solution

## Source code structure and conventions

- [ ] GitHub Actions (This refers to .github/workflows/azure-dev.yml or custom workflow to run on a GitHub runner) is in place
- [x] DevContainer (/.devcontainer folder where applicable) configuration is in place
- [x] Infrastructure as code is in place (`/infra` folder where applicable, manifest files or code generators in the case of `Aspire` and similar )
- [x] Azure services configuration (/azure.yml file) is in place
- [ ] Minimum coverage tests are in place

## Functional requirements

- [x] `azd up` successfully provisions and deploys a functional app
- [ ] GitHub Actions run tasks without errors
- [x] DevContainer has been tested locally and runs
- [x] Codespaces run [locally and in browser]
- [ ] All tests pass

In the absence of e2e tests,

- [x] The application has been manually tested to work as per the requirement

## Security requirements

- [x] Microsoft Managed Identity is implemented
- [x] [microsoft/security-devops-action](https://github.com/microsoft/security-devops-action) is integrated to the CI/CD pipeline and the analyzer were ran

When a service selected doesn't support Managed Identity, the corresponding issue must have been reported and the security considerations section in the readme, should clearly explain the alternatives.

- Azure Key Vault is a preferred alternative

### The following items are not strictly enforced but may prevent the template from being added to the gallery.

Project code follows standard structure, [per language](https://github.com/Azure-Samples/azd-template-artifacts/tree/main/docs/structure-samples). Please check one.

- [x] Yes, follows standards
- [ ] No, doesn't follow standards

Code follows recommended style guide

- [x] Yes, follows style guide
- [ ] No, doesn't follow style guide

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.