Hacking:Making pull requests: Difference between revisions
→Working with feature development
| (5 intermediate revisions by the same user not shown) | |||
Line 1:
__TOC__
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 [https://forum.seamly.net/c/developer 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.
Line 14 ⟶ 16:
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 ==▼
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,
* 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
* Please start your changes from [https://github.com/FashionFreedom/Seamly2D/tree/develop 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 [https://forum.seamly.net/c/developer forum].▼
== Working with feature development ==
Line 21 ⟶ 30:
* 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
* 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.
▲== General recommendations ==
▲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, extend or add new feature and not goes against our goals we will merge such a patch. Even if this patch is not perfect. This rule guarantee that you will not stuck with requests to fix your changes. 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. For example, a fix for an issue from the list would go in a branch named issue-xxx. See [https://guides.github.com/introduction/git-handbook/ the github handbook] for more information about how to use the github tools.
▲* Please start your changes from [https://github.com/FashionFreedom/Seamly2D/tree/develop 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 [https://forum.seamly.net/c/developer forum].
| |||