https://github.com/Escape-Technologies/mookme

A pre-commit tool designed for monorepos.
https://github.com/Escape-Technologies/mookme

monorepo monorepos pre-commit tools

Last synced: 6 months ago
JSON representation

A pre-commit tool designed for monorepos.

• Host: GitHub
• URL: https://github.com/Escape-Technologies/mookme
• Owner: Escape-Technologies
• License: mit
• Created: 2021-05-07T10:05:30.000Z (about 4 years ago)
• Default Branch: beta
• Last Pushed: 2023-10-31T15:32:54.000Z (over 1 year ago)
• Last Synced: 2024-04-14T13:10:01.122Z (about 1 year ago)
• Topics: monorepo, monorepos, pre-commit, tools
• Language: TypeScript
• Homepage:
• Size: 20.3 MB
• Stars: 92
• Watchers: 5
• Forks: 13
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-git - Mookme - A simple and easy-to-use, yet powerful and language agnostic git hook for monorepos. (Hook management / Comparing workflows)

README

        
# MookMe

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

- **[see the documentation](https://mookme.org)**

- **[see the *beta* documentation](https://beta.mookme.org)**



## 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](https://github.com/Escape-Technologies/mookme/projects) in a Github project [WIP]

- A list of [opened issues](https://github.com/Escape-Technologies/mookme/issues) and [merge requests](https://github.com/Escape-Technologies/mookme/pulls)

- Development guidelines and contribution guide [WIP]

## What you will not find on this page

- User documentation. See [the project's website](https://mookme.org)

## 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](https://github.com/Escape-Technologies/mookme/labels/good%20first%20issue), 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.