An open API service indexing awesome lists of open source software.

https://github.com/foundata/guidelines

Recommendations and rules foundata is using to create creative work (which includes source code) or doing operations.
https://github.com/foundata/guidelines

ansible guidelines reuse

Last synced: 2 months ago
JSON representation

Recommendations and rules foundata is using to create creative work (which includes source code) or doing operations.

Awesome Lists containing this project

README

        

# foundata: guidelines, conventions, standards and related documents

This repository collects recommendations and rules [foundata](https://foundata.com/) 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.

## Table of contents

Topics (in alphabetical order):
* [Ansible](#ansible)
* [Git](#git)
* [Licensing](#licensing)

Misc:
* [Continuous release of guidelines and related documents](#continuous-release)
* [Licensing, copyright](#licensing-copyright)

## Ansible

[Ansible](https://www.ansible.com/) is a simple, agentless IT automation tool.

* [Ansible style guide (playbooks) (`ansible-style-guide.md`)](./ansible-style-guide.md)

## Licensing

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

* [How to choose a license (`licensing-how-to-choose-a-license.md`)](./licensing-how-to-choose-a-license.md)
* [How to apply licenses (`licensing-how-to-apply.md`)](./licensing-how-to-apply.md)
* [How to change a license, re-licensing projects (`licensing-how-to-change-a-license.md`)](./licensing-how-to-change-a-license.md)

## Git

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

* [How to name Git repositories (`git-repository-naming.md`)](./git-repository-naming.md)
* [`gitignore` configuration (`git-gitignore.md`)](./git-gitignore.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.

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, 2024 [foundata GmbH](https://foundata.com/)

This project is licensed under the [Creative Commons Attribution Share Alike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/deed) license, see [`LICENSES/CC-BY-SA-4.0.txt`](./LICENSES/CC-BY-SA-4.0.txt) for the full text.

The [`REUSE.toml`](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](https://reuse.software/spec/). You can use [`reuse spdx`](https://reuse.readthedocs.io/en/latest/readme.html#cli) to create a [SPDX software bill of materials (SBOM)](https://en.wikipedia.org/wiki/Software_Package_Data_Exchange).

[![REUSE status](https://api.reuse.software/badge/github.com/foundata/guidelines)](https://api.reuse.software/info/github.com/foundata/guidelines)