Skip to content

Contribution Guide

LouisMNI edited this page Feb 8, 2024 · 4 revisions

Contribution Guide for MESSAG

How to start the app after cloning the repository?

  • Clone the Git repository using git clone https://github.com/AmirKarma/MESSAG.git.
  • Import the project into Godot by clicking on "Import Project," navigating to the cloned directory, and selecting the "project.godot" file.
  • Start the project by clicking on the "Play" button in the top right corner.

What information should a Pull Request contain?

  • Create a new branch before submitting a Pull Request, focusing on the specific feature or bugfix.
  • Choose "feature" as the base for the Pull Request.
  • Provide a clear and concise description along with a meaningful title for the changes made.
  • The Pull Request must be reviewed and approved by at least one other person before merging.

What branches are available?

  • main: The main branch, stable and suitable for production.
  • feature: Contains all ongoing and new features added via Pull Requests.
  • bugfix: Branch for fixing bugs.
  • releases: Prepares stable versions for the release process.
  • devops: Branch for integrating and maintaining CI/CD processes.

Is there version and release management?

Our project follows a clear process for managing releases and version numbers. This guide explains how to integrate new features and create releases.

1. Feature Development

  • Develop new features in separate branches. Each branch should focus on a single feature or specific task.
  • Avoid working directly in the main branch. Instead, create a feature branch, e.g., feature/new-feature.

2. Integration of Features

  • Once a feature is completed and adequately tested, merge the feature branch into the main branch.
  • Ensure that the main branch remains stable and error-free.

3. Creating a Pull Request for the Release

  • Create a pull request to merge the main branch with the releases branch.
  • Describe the changes included and add appropriate tags to identify the release.

4. Automation of Release Creation

  • Our CI/CD pipeline automates release and version management.
  • After merging the main branch with the releases branch, the pipeline performs the following steps:
    • Incrementing the version number according to Semantic Versioning.
    • Creating the release package, including artifacts such as Android, iOS, and Windows exports.
    • Uploading the package to the appropriate hosting service (e.g., GitHub Releases).

Are there code analysis tools or a CI Pipeline?

  • A pipeline automatically checks the code.
  • After each Pull Request, an executable application (APK for Android or the equivalent for iOS and Windows) is automatically built and made available.
  • After merge with releases branch, our CI/CD pipeline automates release and version management and publishes the executable applications.

Please note: Include license information, adhere to coding standards, and encourage respectful communication in issues and Pull Requests. Thank you for your contribution!