dan/waiterr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
waiterr/CONTRIBUTING.md

1.7 KiB
Raw Permalink Blame History

Contributing to waiterr

We welcome contributions to the waiterr project! Please take a moment to review these guidelines before submitting your contributions.

Reporting Bugs and Suggesting Features

If you encounter a bug or have a feature request, please report it on our Codeberg repository.

Git Flow Guidelines

We follow a Git Flow branching model.

  • develop branch: This is our main integration branch for new features and bug fixes.
  • stable branch: This branch contains the latest production-ready code.

Making Changes

  1. Branching:

    • For new features or regular bug fixes, create a new branch from develop (e.g., feat/your-feature-name or bug/your-bug-fix).
    • For urgent hotfixes addressing critical issues in stable, create a branch directly from stable (e.g., hot/your-hotfix-name).

  2. Pull Requests (PRs):

    • All new features and regular bug fixes should be submitted as Pull Requests targeting the develop branch.
    • Hotfixes should be submitted as Pull Requests targeting the stable branch directly. After a hotfix is merged into stable, it must also be merged back into develop.

  3. Commit Messages:

    • It's not required that you follow the Gitmoji convention for your commit messages, but it would make me happy if you did. 😏
    • Write clear, concise, and descriptive commit messages that explain what changed and why.

Code Style

Please ensure your code adheres to the existing Go code style and formatting conventions used in the project. Run go fmt ./... and go mod tidy before submitting your changes.

Thank you for contributing!