CONTRIBUTING.md

taph contributing guidelines

Thanks for contributing to taph! Everyone here is expected to adhere to the Code of Conduct so be sure to review before contributing.

If you're new to open source or Antora, start with First time contributors, otherwise choose a topic below:

Table of contents

• Quick start
• First time contributors
• Directory and file names
• Code and content style

Quick start

First, check if Python is installed.

python --version

If Python's installed, make ./taph.py executable in your shell environment.

chmod +x <path-to-taph>/taph.py

You can pass one or more optional arguments to ./taph.py. For example:

$ ./taph.py -b -m

The output is the following:

'beautify' ran successfully.
'minify' ran successfully.

To see all available arguments, use --help.

./taph.py --help

First time contributors

Version control

Version control allows you to work on documents simultaneously without accidentally overwriting another contributor's work.

• Learn about Git and GitHub
• Get started with GitHub
• Your first pull request

Static site generator

Antora is a static site generator that converts plain text files into HTML and creates a static site using the CSS files in the ui-bundle directory.

• Learn about Antora
• Get started with Antora

File types and markup language

Antora documents are written in a plain-text markup language (AsciiDoc) and only contain written content--not design content--allowing teams to separate writing-related tasks from design-related tasks.

• Learn about the AsciiDoc markup language
• Get started with the AsciiDoc markup language

Directory and file names

All directories and files should adhere to the following:

Naming Guideline	Before	After
Only lowercase letters	This Is My TITLE	this is my title
Replace spaces with underscores	this is my title	this_is_my_title
Replace important symbols	i love c++ & c#	i love cpp and csharp
Remove unimportant symbols	this: is my title!	this is my title

For example:

scripts
├── beautify_logs.py
├── csv.py
├── edit.py
└── minify_css.py

Code and content style

Code and content style should adhere to the following:

• Google's Python Style Guide
• Google's Content Style Guide