Skip to content

How To Contribute

Git Workflow

Setup

Common Workflows

Update your local main branch from upstream

git fetch upstream
git checkout main
git merge upstream/main

Create and push a feature branch

git checkout -b feature/your-feature-name
# Make your changes...
git add .
git commit -m "Your commit message"
git push origin feature/your-feature-name

Create a Pull Request on GitHub

  1. Go to https://github.com/zubzet/framework
  2. Click "New Pull Request"
  3. Select main as base branch
  4. Select your feature branch as compare branch
  5. Create PR and request reviews

Sync your fork with upstream

If main has changed while you're working on a feature branch:

git fetch upstream
git rebase upstream/main
git push origin feature/your-feature-name -f

Keep your main branch in sync

git checkout main
git fetch upstream
git merge upstream/main
git push origin main

Important Notes

  • Always work on feature branches, never directly on main
  • Keep your fork updated frequently to avoid conflicts
  • Push to origin (your fork), create PR to upstream (main repo)

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!