Commit ef781641 authored by Adrian DC's avatar Adrian DC
Browse files

docs(readme): add documentation list for covered topics 

Signed-off-by: default avatarAdrian DC <radian.dc@gmail.com>
parent 35e0fe36

README.md

+13 −1
Changes for README.md: 13 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -4,12 +4,22 @@ 
[![pre-commit-crocodile](https://img.shields.io/badge/pre--commit--crocodile-enabled-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)

[![guidelines](https://img.shields.io/badge/radiandevcore-guidelines-brightgreen?logo=gitlab)](https://radiandevcore.gitlab.io/wiki/radiandevcore)



Guidelines applicable to all RadianDevCore projects and applicable projects.

Guidelines shared for all RadianDevCore projects and for applicable projects.



**Documentation:** <https://radiandevcore.gitlab.io/wiki/guidelines>  



---



## Documentation



Guidelines are available for the following topics:



- **Git:**

    + **Commands:** Important Git commands reference guide

    + **Commits:** Conventional Commits variant 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 :
@@ -26,6 +36,8 @@ Projects compatible with RadianDevCore `guidelines` can use this badge to ease t 


---



<span class="page-break"></span>



## Dependencies



- [commitizen](https://pypi.org/project/commitizen/): Simple commit conventions for internet citizens