How to use this template

If using GitHub to host your extension:

1. Click the Use this template dropdown and Create a new repository item at the top-right of this page
2. Clone the repository to your computer and change to its directory
3. Update the files, as needed
4. Delete any files you have not changed
5. Commit your changes, and push your commit to the repository

If using another host (GitLab, Bitbucket, etc.):

1. Download the template as a ZIP file
2. Extract the files from the ZIP file
3. Update the files, as needed
4. Delete any files you have not changed
5. Publish your extension to your host

Then, register your extension in the Extension Registry.

To learn more about extensions to the Open Contracting Data Standard, read the relevant pages in the Extension Explorer and OCDS documentation.

The rest of this file serves as a template for the extension's documentation. For inspiration, read the documentation of other extensions in the Extension Explorer. For example, the documentation of the Covered By extension includes all of the headings below.

Title Case Name

This extension adds a field to indicate the ... This sentence can be similar to the extension's description in the extension.json file.

For example, ... The following paragraph(s) should explain the extension's use cases and high-level concepts.

Guidance

If needed, this section can describe the extension at a technical level, referring to specific fields, codes, formatted values, etc.

Legal context

If needed, this section can go into greater detail on the legal context for the concepts covered by this extension.

Example

{
  "myField": "A value."
}

Changelog

YYYY-MM-DD

• Add myField field.