Alip Sulistio sampila

Conventional Commit Messages

See how a minor change to your commit message style can make a difference.

git commit -m"<type>(<optional scope>): <description>" \
  -m"<optional body>" \
  -m"<optional footer>"

Commit Message Guidelines

In the last few years, the number of programmers concerned about writing structured commit messages have dramatically grown. As exposed by Tim Pope in article readable commit messages are easy to follow when looking through the project history. Moreover the AngularJS contributing guides introduced conventions that can be used by automation tools to automatically generate useful documentation, or by developers during debugging process.

This document borrows some concepts, conventions and even text mainly from these two sources, extending them in order to provide a sensible guideline for writing commit messages.

Allowed ``

	/*
	* Redact text: Redacts text that match given regexp patterns on a PDF document.
	*
	* Run as: go run redact_text.go input.pdf output.pdf
	*/

	package main

	import (
	"fmt"

	/*
	* Fill PDF form JSON input data and flatten it with a customized appearance to output PDF.
	*
	* Run as: go run main.go.
	*/

	package main

	import (
	"fmt"

	/*
	* Example the usage of UniPDF page splits and AI processing.
	*
	* Run as: go run main.go input.pdf
	* The input PDF file will be split into pages and each page will be sent to the AI for processing.
	* The AI will extract the text from the page and answer the question: "What is the latest experience?".
	*/

	package main

	/*
	* Extract PDF contents to directory : Extract text, tables and images for each page of a pdf file.
	*
	* Run as: go run extract_pdf_contents.go output_directory
	*/

	package main

	import (
	"encoding/csv"

	/*
	* PDF to text: Extract all text for each page of a pdf file and save the results to TXT file.
	*
	* Run as: go run extract_text_to_txt.go input.pdf output.txt
	*/

	package main

	import (
	"fmt"

	/*
	* This example showcases the usage of creator templates by creating a sample
	* airplane ticket.
	*
	* Run as: go run pdf_airplane_ticket.go
	*/

	package main

	import (

	/*
	* This example showcases the usage of creator templates by creating a sample
	* warehouse shipment report.
	*
	* Run as: go run pdf_warehouse_shipment_report.go
	*/

	package main

	import (

	/*
	* This example showcases the usage of creator templates by creating a sample
	* trade confirmation document.
	*
	* Run as: go run pdf_trade_confirmation.go
	*/

	package main

	import (