Skip to content

Escape-Technologies/mookme

Repository files navigation

MookMe

A simple and easy-to-use, yet powerful and language agnostic git hook for monorepos.

demo

What you will find on this repository

  • Description of the repository structure
  • The entire source code associated with the Mookme project, including source code of CLI and the documentation page
  • A roadmap of the project in a Github project [WIP]
  • A list of opened issues and merge requests
  • Development guidelines and contribution guide [WIP]

What you will not find on this page

Repository structure

The Mookme project is architectured around this monorepo. Every packages are stored under the packages folder. These include:

  • /packages/mookme: The NodeJs project for the CLI of Mookme
  • /packages/docs: A vuepress website holding the code of the user's documentation

You are new and willing to contribute ?

There are a few small issues and improvements that you can look into, that are designed and explained for first contributors.

Release channels

Mookme is released under a main channel and a beta channel. These both correspond to the beta and main branches of this repository.

Releases are manual for the beta channel, automated on the main channel.