RadianDevCore - Wiki - guidelines¶
Guidelines shared for all RadianDevCore projects and for applicable projects.
Documentation: https://radiandevcore.gitlab.io/wiki/guidelines
Table of contents
Documentation¶
Guidelines are available for the following topics:
- Git:
- Commands: Important Git commands reference guide
- Commits: Conventional Commits variant reference guide
- GitLab:
- GitLab Issues: Issues labels and issue boards guide
- Terminals:
- .bashrc: Bash configurations and reference guide
Compatibility¶
Projects compatible with RadianDevCore guidelines
can use this badge to ease things for developers, both as an indicator and a documentation shortcut button :
Badge in Markdown
[](https://radiandevcore.gitlab.io/wiki/guidelines)
Badge in HTML
<a href="https://radiandevcore.gitlab.io/wiki/guidelines"><img src="https://img.shields.io/badge/randiandevcore-guidelines-brightgreen?logo=gitlab" alt="radiandevcore-guidelines" style="max-width:100%;"></a>
Dependencies¶
- commitizen: Simple commit conventions for internet citizens
- pre-commit: A framework for managing and maintaining pre-commit hooks
- pre-commit-crocodile: Git hooks intended for developers using pre-commit
References¶
- .gitlab-ci.yml: GitLab CI/CD Pipeline Configuration Reference
- conventionalcommits: Conventional Commits specification for commit messages
- gcil: Launch .gitlab-ci.yml jobs locally
- git-cliff: CHANGELOG generator
- mkdocs: Project documentation with Markdown
- mkdocs-exporter: Exporter plugin for mkdocs documentation
- mkdocs-material: Material theme for mkdocs documentation