{{repo_name}}

Note

What is this template repository about and how to use it:

• For codeowners of existing CAMARA repository it is a sample how a CAMARA repository should look like, e.g. to update legacy repositories. Have a look specifically on the code of the README.md for different variants and copy relevant parts into your repository.
• For CAMARA admins to create new (Sandbox) API repositories automated: Use the setup-new-repo workflow together with documentation in templates/README.md.

The following is the template README for a new independent Sandbox repositories, Sandbox repositories within a Sub Project, and Incubated Repositories. Further variants are within the commented code.

This note must be deleted in newly created repositories

---

Sandbox API Repository to describe, develop, document, and test the {{repo_name}} Service API(s). The repository does not yet belong to a CAMARA Sub Project.

• API Repository wiki page

---

Sandbox API Repository to describe, develop, document, and test the {{repo_name}} Service API(s) within the Sub Project {{subproject_name}}.

• API Repository wiki page

---

Incubating API Repository to evolve and maintain the definitions and documentation of {{repo_name}} Service API(s) within the Sub Project {{subproject_name}}

• API Repository wiki page

Scope

• Service API(s) “{{repo_name}}” (see APIBacklog.md)
• The API(s) provide(s) the API consumer with the ability to:
  • §Short API scope description§ !! Add here a scope description according to the API proposal
• Describe, develop, document, and test the API(s)
• Started: §start date§

Release Information

The repository has no (pre)releases yet, work in progress is within the main branch.

Contributing

• Meetings are held virtually

  • Schedule: !! tbd
  • Registration / Join !! Update this link with your meeting registration/join link and delete the task
  • Minutes: Access meeting minutes !! update this link to your minutes archive page using the "Share" link and delete the task

• Mailing List

  • Subscribe / Unsubscribe to the mailing list https://lists.camaraproject.org/g/{{mailinglist_name}}.
  • A message to the community of this Sub Project can be sent using {{mailinglist_name}}@lists.camaraproject.org.