azure-search-openai-demo-csharp icon indicating copy to clipboard operation
azure-search-openai-demo-csharp copied to clipboard

Acceptance Criteria Checklist (DoD)

Open anfibiacreativa opened this issue 1 year ago • 5 comments

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

Repository Management

  • [x] Standards compliant README.md as the one in the example, is in place
  • [x] License is in place. Make sure you choose the correct license
  • [ ] Security guidelines are in place
  • [x] Contribution guidelines are in place
  • [x] Code of conduct is in place
  • [x] Issue template is in place
  • [x] Language, model, and relevant technology topic labels are added, including azd-templates and ai-azd-templates (The latter is being created)
  • [x] Repo description is in place, describing the use case and technologies used in the solution

Source code structure and conventions

  • [x] 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
  • [x] GitHub Actions run tasks without errors
  • [x] DevContainer has been tested locally and runs
  • [x] Codespaces run [locally and in browser]
  • [x] All tests pass

In the absence of e2e tests,

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

Security requirements

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. Please check one.

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

Code follows recommended style guide

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

anfibiacreativa avatar May 14 '24 11:05 anfibiacreativa

@luisquintanilla Please review the pending items or assign to corresponding contributor to help close the issue. Thank you!

anfibiacreativa avatar May 14 '24 11:05 anfibiacreativa

@LittleLittleCloud can you please take a look when you get a chance. Thanks!

luisquintanilla avatar May 14 '24 13:05 luisquintanilla

@anfibiacreativa The secruity guideline link is broken, can you fix that

LittleLittleCloud avatar May 14 '24 17:05 LittleLittleCloud

@anfibiacreativa The secruity guideline link is broken, can you fix that

Hi. That's because it is not in place. It should be added to the root.

anfibiacreativa avatar May 15 '24 17:05 anfibiacreativa

@anfibiacreativa I'm refering to this link. which gives me a 404...

Would you share an example of SECURITY.MD that I can added to the repo

image

LittleLittleCloud avatar May 15 '24 17:05 LittleLittleCloud