# Submit a library

**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,
* &#x20;you can also add the generated yaml (assuming you have tested it) under `backend/library/libraries`&#x20;
* open a pull request and make sure you accept the CLA

and we'll take it from there :thumbsup:

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

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

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2F8uge5ax26Uh3MJVj1Sxx%2Fscsh-2024-12-31-17.15.09.png?alt=media&#x26;token=b53ffbf9-597f-4c3e-b644-c673f87ad9e1" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2FwI0fJsHDngBLyKKfiJuK%2Fscsh-2024-12-31-17.16.43.png?alt=media&#x26;token=49e9bff8-6313-4031-9b63-63ebd9310232" alt=""><figcaption></figcaption></figure>

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2Fdi9fWUXFU29kgRGcM8y8%2Fscsh-2024-12-31-17.18.01.png?alt=media&#x26;token=c645308c-e93d-422b-84ea-e155d5a4ff2c" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2FICLH9VksWyJkiAkWrx6l%2Fscsh-2024-12-31-17.21.17.png?alt=media&#x26;token=33d92cc0-5bcc-4356-b952-af9d55812ac6" alt=""><figcaption></figcaption></figure>

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2FOGkDR5COWRmkuBPqmAtp%2Fscsh-2024-12-31-17.23.09.png?alt=media&#x26;token=1838cda1-d33d-40ee-8de2-66f5d294b889" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2F5xeSpjpVrUyyeDP5pF40%2Fscsh-2024-12-31-17.24.19.png?alt=media&#x26;token=bcc31f4d-8d7c-46ef-b20d-d8104280f2f9" alt=""><figcaption></figcaption></figure>

* go to the `tools` folder

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2Ffiusk9Lvqq9quM8JFS0j%2Fscsh-2024-12-31-17.36.12.png?alt=media&#x26;token=2300b2e3-5764-40ac-8ce7-148516b9c914" alt=""><figcaption></figcaption></figure>

* click `Add file` and click `Upload files`&#x20;

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2F9oJmjAPfUjEoxdSpyves%2Fscsh-2024-12-31-17.37.38.png?alt=media&#x26;token=6682cb87-3c38-4de7-b8c6-cd1ee673b603" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2FHXc2RvfwIKKYbsOkJSas%2Fscsh-2024-12-31-17.38.45.png?alt=media&#x26;token=8fabe75e-eb8d-443d-9b98-4daef4ae604e" alt=""><figcaption></figcaption></figure>

* commit the changes

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2FeEnLyR1mNRU1uiBMKT1Q%2Fscsh-2024-12-31-17.39.47.png?alt=media&#x26;token=5d7ccf10-951f-4dc2-9aa3-cd1f80462c7c" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2FgSbLni4SoaNiqU5bK2hF%2Fscsh-2024-12-31-17.40.23.png?alt=media&#x26;token=b65b4b63-32a6-4185-9db0-75579ab43bb1" alt=""><figcaption></figcaption></figure>

* 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:

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2F9dhQ6DyuL4ztzKhPm6e9%2Fscsh-2024-12-31-17.40.57.png?alt=media&#x26;token=b63293de-c2cb-45c5-92c1-b23735e6191f" alt=""><figcaption></figcaption></figure>

<figure><img src="https://217025809-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUJGpmCYDFJNsz2CDasSm%2Fuploads%2Fub5VHXNP0UQ2AKgrCFsw%2Fscsh-2024-12-31-17.41.54.png?alt=media&#x26;token=b06a8f2d-eff9-4aac-bc50-eb582260c463" alt=""><figcaption></figcaption></figure>

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 :wink:
