Skip to content

How To Contribute

Commit Messages

We previously used gitmoji for commits. From now on, we use Conventional Commits instead, to respond to feedback and align with standard practices.

Format: <type>(<scope>): <short summary>

Examples: - feat: add a query builder - chore(dev): setup docker development environment - test: migrate all qa-suite tests

Documentation

  1. Clone the Repository 

    git clone https://github.com/zubzet/framework.git

  2. Start a Live Preview: Use the following Docker command to start a live preview of the documentation on port 8000: 

    docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

  3. Make Changes: Edit or add files under the /docs directory. Any changes will be automatically reflected in the live preview.

  4. Submit a Pull Request: Once you’ve made your changes, push them to your fork and create a pull request to contribute your improvements.


Thank you for helping improve the ZubZet framework!