Casino (Gwydion)
12. Contribution Guidelines
Contributions to the casino software are highly encouraged, and the following guidelines are provided to ensure a smooth and collaborative development process. While repository-specific details may vary, a standardized Git-flow workflow is adopted across all projects to maintain consistency.
12.1 Git-flow Workflow
The Git-flow workflow is a branching strategy that provides a structured approach to collaborative development. This workflow streamlines feature development, release management, and hotfix deployment. The main branches used in the Git-flow workflow include:
main: The main branch represents the stable production-ready code. Only releases and hotfixes are merged intomain.develop: The develop branch serves as the integration branch for ongoing feature development. Feature branches are merged intodevelopupon completion.Feature Branches: Feature branches are created for the development of specific features or enhancements. These branches originate from the
developbranch and are merged back intodevelopupon completion.Release Branches: Release branches are created to prepare for a new release. They are created from the
developbranch and merged into bothmainanddevelopupon release.Hotfix Branches: Hotfix branches are created to address critical issues in the production code. They are created from
mainand merged into bothmainanddevelopupon completion.
12.2 Repository-Specific Guidelines
While the Git-flow workflow is standardized across all projects, each repository may have specific guidelines and requirements. Refer to the repository-specific README or CONTRIBUTING file for details on:
Branch Naming Conventions: Naming conventions for feature branches, release branches, and hotfix branches.
Commit Message Guidelines: Guidelines for writing clear and descriptive commit messages.
Code Style and Standards: Specific coding standards and style guidelines to follow.
Testing Requirements: Guidelines for writing tests and ensuring comprehensive test coverage.
12.3 Pull Requests
Contributions are accepted through pull requests (PRs). When submitting a PR, ensure the following:
- The PR is based on an up-to-date
developbranch. - The changes are well-documented, and the code follows established coding standards.
- Tests (if applicable) pass successfully.
- The PR title and description provide clear context and information about the changes.
12.4 Code Reviews
All code changes go through a review process. Reviewers assess code quality, adherence to standards, and overall contribution value. Address feedback promptly and iteratively update the pull request as needed.
By adopting the Git-flow workflow and following repository-specific guidelines, contributors can collaborate effectively, maintain code quality, and streamline the development lifecycle.