|
| 1 | +# Contributing on project |
| 2 | + |
| 3 | +## Fork repository |
| 4 | + |
| 5 | +1. Go to https://github.com/comodit/comodit-client |
| 6 | +2. Fork project in your repository |
| 7 | +3. Clone forked project in your laptop |
| 8 | +4. Configure remote project |
| 9 | + |
| 10 | + $ git remote add upstream https://github.com/comodit/comodit-client.git |
| 11 | + |
| 12 | +more information [GitHub help](https://docs.github.com/en/get-started/quickstart/fork-a-repo) |
| 13 | + |
| 14 | + |
| 15 | +## Create new branch for feature or fixed |
| 16 | + |
| 17 | +> if you cloned your repository not now. Read before Retrieve change from source project |
| 18 | +
|
| 19 | +Create branch |
| 20 | + |
| 21 | + $ git checkout -b branchName |
| 22 | + |
| 23 | +Commit changes |
| 24 | + |
| 25 | + $ git commit -am "description of change" |
| 26 | + |
| 27 | +Push changes |
| 28 | + |
| 29 | + $ git push origin <branch_name> |
| 30 | + |
| 31 | +## Create PullRequest |
| 32 | + |
| 33 | +1. Go to https://github.com/<REPO_NAME>/comodit-client/branches |
| 34 | + |
| 35 | +####  |
| 36 | + |
| 37 | +2. Click to create "New pull request" |
| 38 | + |
| 39 | +####  |
| 40 | + |
| 41 | +In GitHub flow, Pull request merge directly in branch master of source project |
| 42 | + |
| 43 | +3. Click on create button "Create pull request" |
| 44 | +4. Verify your change |
| 45 | +5. Ask to someone to verify your change and accept the pull request |
| 46 | + |
| 47 | +more information [GitHub help](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request#changing-the-branch-range-and-destination-repository) |
| 48 | + |
| 49 | + |
| 50 | +## Accept PullRequest with squash |
| 51 | + |
| 52 | +When you accept the change, select and merge and push on it. |
| 53 | + |
| 54 | +This option create only one commit with all your commit and you can write a description for details. |
| 55 | +Now your change it's on branch master of comodit-client repository |
| 56 | +###  |
| 57 | + |
| 58 | + |
| 59 | +## Retrieve change from source project |
| 60 | + |
| 61 | + $ git checkout master |
| 62 | + $ git fetch upstream |
| 63 | + $ git rebase upstream/master |
| 64 | + |
| 65 | + |
| 66 | + |
0 commit comments