submit-a-library-framework.md

description
How to submit a framework, matrix or catalog to the community repository

Submit a library (Framework)

If you are familiar with Github and Git, the submission is pretty straightforward:

• fork the git repo and make sure it's sync-ed up
• add the excel sheet under the tools folder,
• you can also add the generated yaml (assuming you have tested it) under backend/library/libraries
• open a pull request and make sure you accept the CLA

and we'll take it from there 👍

If you're not familiar with Github and the handling Git, you can follow these simplified steps using just the UI :\

• create your excel sheet based on one of the samples in tools folder
• convert it to yaml using the convert_library.py tool

• Test it to make sure it can be parsed by the app and matches what you are expecting

• sign up on github to create an account and head to ciso assistant repository
• create your fork of the repository

• if it's not your first time, make sure your fork is up to date

• go to the tools folder

• click Add file and click Upload files

• drag and drop the excel file you've prepared or pull it from your filesystem.
• add a commit message, something like "Submitting framework x"

• commit the changes

• if everything went well, you should see a message indicating that you're 1 commit ahead.

• Optional: you can repeat this process to add the yaml file as well but on the backend/library/libraries/ folder instead.
• You can now open the pull request:

There are of course other ways to achieve this in a much cleaner approach, but this is intended for a beginer discovering git and GitHub 😉