Hacking:Making pull requests

From Seamly2D
Jump to: navigation, search

The intended audience for this page is anyone who wants to contribute to the open source project and is not a member of the core development team. To be added to the core development team requires special privileges and access that can be granted by the repository owner. If you wish to become a member of the core team, please make a request on the forum.

This page describes how to create a pull request. We highly recommend you to read this page before you will decide to send us your changes.

Note: this is not a tutorial on Github. For more information about Github see our page about Hacking:Tools.

Branch model[edit | edit source]

First you should know little bit about our workflow. Right now we work with the Gitflow model of named branches.

  • master - used only for releases.
  • develop - branch that contains a code for the next major release. Code in this branch good enough for testing and sharing among developers.
  • release-x.x.x - used for feature freeze state before the next major release. And for preparing the next minor release.
  • feature-issue# - branch that contains a code for unfinished, new, or improved features. Merge to develop. (e.g. feature-155 to name your fix for issue #155)
  • hotfix-x.x.x - Create from develop and master. Contains a quick fix. Merge to master (or release) and develop.

These are the main branches you should know about. There are several long term task specific branches in repository too. But we will not discuss them in this document.

General recommendations[edit | edit source]

There are several things you should know for successful creating a pull request.

NOTE: INSERT UPDATED, GIT BASED, WORKFLOW EXAMPLE HERE
  • As open source community we try to be open as possible. This mean if your changes fix something, or adds a new feature and and does conflict with the project our goals we will merge such a patch. Even if this patch is not perfect. We will help you by continue working with your code after merging.
  • It is easiest for others to understand your intent if you follow naming conventions. Please use a convention of creating a branch to save your work in the github repository. See the github handbook for more information about how to use the github tools.
  • Please start your changes from the Seamly2D repository develop branch. You may use the fork command to create your own copy of the repository. If you are not sure, please, ask for help in the forum.

Working with feature development[edit | edit source]

  • Implement a feature step by step and save your progress.
  • Please make commit back to the develop branch only if you have finished a step. There is no reason to make a commit for a partially finished step today. You can continue tomorrow. The interim code may be stored in your cloned copy of the repository or in a feature branch.
  • Each commit should be small as possible and contain one logical step of developing a feature. This will help us better understand your code. The member of the core development team who does the review and merge for the commit may be in a different geographic area and time zone. The project is primarily staffed by volunteers. For these reasons, we will sometimes see changes associated with each commit separately.
  • Before a commit is made, the code should be successfully compiled.
  • Make all your commits in your local develop branch. This mean all your changes in your local repository will be only in develop branch.
  • Don't forget each day sync your repository with ours and merge new code from the fashionfreedom develop branch -> to your develop branch. Fix all merge conflicts.
  • You can push your develop branch to github. This will help us watch your progress and leave comments. We recommend that you don't hide your code until the end.
  • When you will decide that all were done create a pull request. In settings set to push your develop/release branch to the upstream repository.
  • If we ask you to fix some issues related to your changes continue commit them to the develop/release branch and push them to github. It will automatically update your pull request.