"warning":"The [main documentation](https://github.com/bakhirev/assayo/blob/main/documents/RU.md) is in russian. This is a translation. It may contain errors. If you a native speaker, you can help improve this translation. Thanks!"
"p":"Visualization and analysis of git commit statistics. Team Lead performance tool. ([demo](https://assayo.online/demo/?ref=github&lang=en&dump=./test.txt), [install](https://assayo.online/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo))."
"p":"Git will create a file `log.txt`. This file contains data for show a report. The difference between the online and offline format is the presence of a wrapper for strings. The offline format will be pulled up like a `js` file if you just opened `/build/index.html `"
"p":"By default, the output encoding may not match UTF-8 and the resulting log file will be unreadable. Before saving the log, you can change the encoding with the command."
"h3":"How to view a report on a group of microservices?"
},
{
"li":[
"generate for each microservice file `log.txt` (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) You can do this manually, or use the [Assayo Crawler](https://github.com/bakhirev/assayo-crawler) module for automatic log collection;",
"see “How to view an online report?”. At the last step, drag all the files at once into the browser window.",
"see “How to see a report offline?”. At the second step, drag all microservice files (`log-1.txt`, `log-2.txt`, `log-3.txt` and etc.) to the report folder (`/build`)."
]
},
{
"h3":"How to brand the interface?"
},
{
"p":"You can create your own interface theme. Options:"
},
{
"li":[
"**Title**. You can set default document title in the URL parameter ```title```. Example: ```?title=You Company```",
"**Visual theme**. To do this, you need to prepare a CSS file with new styles and specify its URL in the ```theme``` parameter. Example: ```?theme=//company.com/some.css```. You can use class names as selectors. Most of them do not change in new versions.",
"**Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es```"
]
},
{
"h3":"How to sign commits?"
},
{
"p":"Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example:"
},
{
"pre":[
"JIRA-1234 feat(profile): Added avatar for user "
]
},
{
"li":[
"task number in the task tracker `(JIRA-1234)`",
"type of work `(feat, fix, style, refactor, test, doc и т.д.)`",
"feature `(profile - new page on site or new function, use one (two) short wordor an abbreviation)`",
"what problem were solved `(Added avatar for user)`"
]
},
{
"h3":"How to add checking for commit message?"
},
{
"h4":"Use file `commit-msg`"
},
{
"p":"1. Create file `commit-msg` in folder `.git/hooks/`"
"open `build/index.html` in the browser and add it to bookmarks;",
"add a shortcut to `build/assets/ci-cd.sh` to the startup folder (Windows);"
]
},
{
"p":" Every time you restart the computer, the script will update statistics on all the data that automatically merged into the main branch."
},
{
"h3":"DevOps (CI/CD)"
},
{
"h4":"Public server"
},
{
"p":"You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://assayo.online/?ref=github&lang=en) to visualize it."
"p":"1. [Reports showcase UI](https://github.com/bakhirev/assayo-showcase) displays a list of available reports. Each report consists of a title, description, and a list of repositories."
