#85_Third_Party_library_adding_process

Spike #85 - Process for adding third-party libraries

Shane Vincent - 09/04/2019

Updated: 15/04/19

Goals / Deliverables

A guide to adding third-party libraries/software to our project. It will include the processes of checking the library/software, checking whether it's compatible with our project and adding a reference to it in a dedicated document.

Technologies, Tools and Resources Used

• Best practices
• Evaluating third-party libraries

What we found out

Checking the library/software

Figure out if it is a good fit:

• Does it do what we need it to do?
• How much time will be spent customizing it to satisfy our requirements?
• Do we plan on extending this in the future? If so, will the library allow room for expansion?

Evaluate whether it is worthwhile. Have a look around where you have found it and try to learn more about it:

• How many people are using it? Generally the community can shed light on whether it's being well maintained and of good quality.
• How long has the library been around for? Mature libraries are usually better than new ones, but might not still be active.
• Does the library have an active maintainer? If so, do they engage with the community?
• Does a Google search or StackOverflow search yield positive comments and questions with definite answers, or does the community seem to be struggling with the implementation of this library/software?

Licensing

Only some licenses will work with our project. Check the acceptable license page on the wiki to figure out whether the license of that library/software is appropriate for use in our project.

Adding it to the wiki

If you end up adding this library to the project then you must also add the license of the third-party library to the [wiki page for used licences]

(https://docs.google.com/spreadsheets/d/1JBfES5GyR0PX2k0xXWG1XyFLgJ7_VYJK9HWqUOIve1s/edit?usp=sharing) Add details about the third-party library to the wiki, including where it was found, who added it, what licenses it used, etc.

In the case of adding third-party software, also include the same information for any components of that software and what licenses those components use as well.