Home

Welcome to the tip-initiative-apis wiki!

So you want to help and are looking for a simple guide? You've come to the right place. We hope this documentation serves as a good first step!

First, you may want to familiarize yourself with the TIP initiative and the group working on the technical aspects of it. The documentation is conveniently located here: TVB TIP Links .

The next step will likely be some basic tooling and some pointers on how all of this works, in case you don't already know. Don't worry if the information becomes a little confusing. There are a number of people from the group who can help orient you and there are checks to prevent accidents from adversely affecting the code-base, so don't be scared.

Tooling

Microsoft Visual Studio Code -- A good text editor is all you need to alter the code in this repository, but if you want syntax highlighting and additions that make life a little easier, you may want to use an actual editor like a free tools we recommend, Visual Studio Code.

VS Code YAML extension is the VS Code extension that will give you the syntax highlighting for YAML. Syntax highlighting changes the color of the words in a document to indicate its syntactic function.

VS Code Open API (Swagger) Editor is the extension that will allow you to navigate the OAS document more easily and verify that the code is written correctly.

SourceTree - Git GUI that can make interacting with GIT a little bit easier if the command line interface (CLI) of GIT is intimidating. There are a number of GIT Gui's out there, and VS Code even has extensions that make life easier all in the same tool. Some are better than others when it comes to features and ease of use and this recommendation is a good start.

[Technical Documents]

Here are a list of documents you may want to familiarize yourself with in order of importance when contributing to this repo.

TIP Initiative Google Doc details out the properties that are or will be included in this code base.

GIT Flow give you and introduction in how GIT specifically works and how version control systems (VCS) work in general.

Open API Specifications 3.0 is the structure the TIP initiative follows when creating TIP API specifications.