This repository contains definitions of custom classes that OCA application developers are sharing for public use. Some of these classes are so-called "Adaptation" classes, defined by the AES in Adaptation standards such as AES70-21; others are proprietary classes whose definitions their makers would like to share. All of the definitions are offered on an as-is basis, and are free to use.
This project is licensed under the 0BSD License - the file LICENSE.txt contains a copy of it.
Software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Full guidelines for use of and contribution to OCA Alliance open-source software projects are here: https://ocaalliance.github.io/opensource.html.
This repository has the following structure:
| FOLDER OR FILE | CONTENTS |
|---|---|
| contributions | Container for all contribution subfolders |
| contributions/contributorName(1) | Contribution folder (1) |
| contributions/contributorName(n) | Contribution folder (n) |
| LICENSE.txt | Copy of software license |
| DCO.txt | Copy of Developer's Certificate of Origin to use |
| README.md | This file |
Each contributor has their own folder. The folder's name is the name of the entity that owns the content - an organization or an individual - or a reasonable short form of that name.
Contribution folder contents should be as follows:
| FOLDER OR FILE | CONTENTS |
|---|---|
| File(1) | Class Descriptor or other file or subfolder |
| ... | |
| File(n) | Class Descriptor or other file or subfolder |
| README.md | Readme file |
In general, the contents of a contribution folder may be structured in whatever way is appropriate for the contributed material. Content may include Class Descriptors, the README file, other files, and subfolders.
A class Descriptor is a file in JSON format that describes one or more AES70 classes or datatypes. A JSON schema that defines this format is on this repository's home page, here.
Each contribution README file should begin with information that appropriately identifies the contribution's owner and submitter. Suggested information items include:
- Name of contributor (organization or individual)
- Name of submitter, if different from above
- Contact information - email, phone, etcetera
- Website URL(s), if applicable
The file should describe the contributed content in appropriate detail and/or point to detailed online documentation.
The contribution folder can contain other relevant files - documentation, data, whatever. However, the inclusion of large files - videos, for example - is discouraged. Please provide links to such files instead.
The contribution folder may contain subfolders as required.
Contributions are welcomed and encouraged. Anyone may contribute to this project by submitting a Git Pull Request to the project's repository. No prior authorization is required.
The comments field of every submitted Pull Request must contain a brief text that certifies the contributed content complies with the terms of the Developer's Certificate of Origin (DCO), a simple document written by the Linux Foundation that attests the contributor has sufficient rights to make the contribution. A copy of it is in the file DCO.txt.
Pull Requests without DCO certifications will not be accepted by the Repository Manager, and should be resubmitted with certification included.
The required Pull Request text is as follows:
The entire content of this Pull Request complies with the Linux Developer Certificate of Origin, the text of which is at https://developercertificate.org/. (Add full name and email)
For your first submission, you'll need to create your submission folder. Please build it in the format described above. Otherwise, the submission should simply contain the material to be included in your contribution folder.
Don't forget to include the Developer's Certificate of Origin in your Pull Request comments.
Thanks for your support of the OCA Ecosystem.