Skip to content
This repository has been archived by the owner on Jul 2, 2018. It is now read-only.

GitHub Specifics

Natasa Bulatovic edited this page Jul 26, 2016 · 1 revision

Watch Us / Get the source code on GitHub You can download this project in either zip or tar formats. You can also clone the project with Git by running:

$ git clone https://github.com/imeji-community/imeji.git

 

REST API

See REST API v1 (imeji Community wiki)

GitHub Repository Policy

Roles

  • repository manager: This person is responsible for all operation in the repository. Is the only one allowed to manage (create, delete, merge)the release branches and to commit into master.
  • community developers: Can create a feature branch and commit in development branch
  • external developers: Is responsible in its own repository, can commit into imeji repository via pull-request

Branches

  • master: The master branch contains the releases.
  • develop: it contains the current state of the development.
  • feature branch: it contains the development of a specific feature. The name of the branch should look like: feature-featureName
  • hotfix branch: A branch to fix bug of the current release. The name of the branch should look like: hotfix-hotfixVersionNumber
  • release branch: Is created to prepare a new release. Lives so long the release is not finished

Rules

  • The development is made in the development branch
  • New features are developed in a feature branch. This branch is created by a developer from the last commit in the develop branch. When the feature is ready, the branch is merged into develop and then deleted. The developer who created this branch is responsible to manage possible conflict with the develop branch (frequent merge from develop into feature branch recommended)
  • When the sofware is about to be released, the repository manager creates a release branch from the last commit of develop. He is responsible to merge potential changes made in develop branch. The release process will happen in this branch. At the end of the release, he will merge this branch into master and develop, and then remove the release branch
  • If a bug fix release is needed, a hot fix branch will be created out of the last commit in master (i.e. the last release). All bug fixes will be made directly into this branch, as well as the release process. When the bugs fix has been releases, the branch is merged into master and into develop. The repository manager is responsible for the creation, the release, the merge and the delete operations. All other developers can contributes into this branch to the bug fix.

Workflow Illustration

Functionalities_Git-flow

More

For more information, with illustrations and code snippet, see the detailed git flow.

Clone this wiki locally