CONTRIBUTING.md

Contributing to Backbone Message Formats

Last updated: 01 Dec 2022

Guidelines for our project partners to collaborate in this workspace specifically for message formats that interact with each partner's software components and the Communications Backbone.

Where To Find A Brief on Message Formats

Please refer to the README.md file that summarises the message types and message flows.

Info: Quick Links might be helpful too!

Commenting

A great way to collaborate and refine the message formats is by commenting on the schema definitions/examples (within the code itself) or on an issue card.

Commenting on Code

Go to Merge Requests, add your comment and click Add comment now. Be sure to tag partners who should response. Use @ followed by the partner's username or tag a partner's organisation by adding a label.

P.S. The initial working branch is create-initial-message-formats.

But HOW Do I Add A Comment?

A. To comment directly on the master branch directly, hover over the left column that shows the line numbers, and click on the paperclip icon. This copies the specific line of code. You can then proceed to pasting this link into a new issue as per Raising New Ideas or Questions.

B. To comment on a Merge Request, hover over the left column that shows the line numbers, and click on the paperclip or comment bubble icon. This copies the line of code. You can then proceed to pasting this link into a new issue as per Raising New Ideas or Questions.

Commenting on Issue Cards

Go to the issue, scroll to the bottom of the page and add your comment. Once done, click on Comment.

Raising New Ideas or Questions

If you have an idea or a question for our collaborators, it's simple! Create a new issue, assign a person to respond/take action under Assignee, and add a partner under Labels .

Labels Summary

To add/edit labels, go to manage labels.

Category	Labels Available	Description
Project	SoAR	Associated project
Partner	Planet Ocean, Hydro-Surv, NOC, RHU	Associated partner
Asset	ah1, ecosub, reav, autonomy engine	Associated platform
Status	In Sprint Backlog, In Progress, In Review, BLOCKED	Status of resolving issue
Weight	0, 1, 2, 3, 5, 8	Complexity of issue (0 - quick task and 8 - full 2 weeks worth of work)
-	bug, feature	Type of issue i.e. new feature, bug

Quick Links

1. Schema Fields Definitions
2. JSON Schema Examples

Project-Specific: SoAR Project

• Reference SoAR Message Format Slides
• To view schema docs via Swagger UI, run the command below and go to http://127.0.0.1:5000

  python3 docs/generate_swagger.py

  *Disclaimer: These are not endpoints. Purely for schema representation purposes.

  TEMPORARY: Pregenerated Swagger docs can be viewed here.

Getting Started

Notes for this section is in PROGRESS

1. Clone this gitlab repository:

git clone https://git.noc.ac.uk/communications-backbone-system/backbone-message-format.git

2. Install the dependencies from requirements.txt.