foundata: guidelines, conventions, standards and related documents

This repository collects recommendations and rules foundata is using to create creative work (which includes source code) or doing operations. What makes sense to share in public will find its place in this repository.

⭐ Found this useful? Support open-source and star this project:

Table of contents

Topics (in alphabetical order):

• Ansible
• Container images
• Git
• Go
• Markdown
• PowerShell scripting
• Python
• Shell scripting
• Licensing

Misc:

• Continuous release of guidelines and related documents
• Licensing, copyright

Ansible

Ansible is a simple, agentless IT automation tool.

• Ansible playbook guidelines (ansible-playbooks.md)
• Ansible roles and collections (ansible-roles-collections.md)
• Ansible module development guide (ansible-modules.md)

Container images

Resources on how to build and publish OCI container images from Containerfiles:

• OCI container image build and release guide (oci-images.md)

Licensing

Resources on how to choose, apply or change a license.

• How to choose a license (licensing-choose.md)
• How to apply licenses (licensing-apply.md)
• How to change a license, re-licensing projects (licensing-change.md)

Git

Resources on how to work with, maintain and host Git repositories.

• Git commit message guide (git-commits.md)
• How to name Git repositories (git-repository-naming.md)
• gitattributes configuration (git-attributes.md)
• gitignore configuration (git-ignore.md)

Go

Resources on how to develop and maintain Go applications, commands and libraries:

• Go style guide (go.md)

Markdown

Resources on how to write and maintain technical Markdown documents:

• Markdown style guide (markdown.md)

PowerShell scripting

Resources on how to develop and maintain PowerShell scripts:

• PowerShell style guide (powershell.md)

Python

Resources on how to develop and maintain Python applications, libraries and scripts:

• Python style guide (python.md)

Shell scripting

Resources on how to develop and maintain shell scripts:

• Shell scripting style guide (shell-scripting.md)

Continuous release of guidelines and related documents

Our guides are updated continuously, meaning:

• Changes are immediately put "live" by publishing them after a review.
• There is no special versioning, neither for the documents themselves nor for the repository.
• As Git and a repository hosting are used, permanent links to specific "versions" are still easy and possible if needed.

The OCI container image build and release guide is an exception to this continuous-release model. It is a versioned ruleset implemented by ConClear, so a revised guide becomes effective only when its coordinated, compatible ConClear release is available. ConClear embeds the exact guide commit it implements and owns stable identifiers for its automated checks. The guide assigns a stable identifier to every requirement; ConClear's conformance documentation maps each check to the requirements it covers.

We believe that guides are work in progress and will probably never be finished as our understanding of each topic evolves. This fits our overall agile approach.

Licensing, copyright

Copyright (c) 2020, 2023-2026, foundata GmbH https://foundata.com

This project is licensed under the Creative Commons Attribution Share Alike 4.0 International license, see LICENSES/CC-BY-SA-4.0.txt for the full text.

The REUSE.toml file provides detailed licensing and copyright information in a human- and machine-readable format. This includes parts that may be subject to different licensing or usage terms, such as third-party components. The repository conforms to the REUSE specification. You can use reuse spdx to create an SPDX software bill of materials (SBOM).

Trademarks

Third-party trademarks used in this repository:

• Active Directory® is a trademark of Microsoft Corporation, registered in the European Union and the United States.
• Ansible®, CentOS®, Fedora®, Quay®, Red Hat® and RHEL® are trademarks of Red Hat, LLC, registered in the United States and other countries.
• Debian® is a trademark of Software in the Public Interest, Inc., registered in Germany and the United States.
• Docker® is a trademark of Docker, Inc., registered in the European Union and the United States.
• Kubernetes® is a trademark of The Linux Foundation, registered in the European Union and the United States.
• Linux® is a trademark of Linus Torvalds, registered in Germany, the European Union and the United States.
• PowerShell® is a trademark of Microsoft Corporation, registered in Germany and the United States.
• Ubuntu® is a trademark of Canonical Ltd., registered in Germany, the European Union and the United States.
• Windows® is a trademark of Microsoft Corporation, registered in Germany, the European Union and the United States.

Their use here is purely descriptive and does not imply any affiliation with or endorsement by the trademark holders.

Own and licensed trademarks used in this repository:

• foundata® is a trademark of IPAM GmbH, registered in Germany and the European Union, licensed to foundata GmbH.