Maintain packages with Git - Revision history

MymsMan: /* Commit your changes */

2020-04-02T13:02:25Z

‎Commit your changes

2020-03-11T13:48:05Z

remove 'Draft' designation

2020-03-11T13:36:09Z

‎Fork and clone reposiory

2020-03-11T13:35:11Z

‎Fork and clone reposiory

2020-03-11T13:33:58Z

add not visible comment

2020-03-02T16:01:18Z

‎Create a Branch

2020-02-25T16:48:32Z

Completed first draft

2020-02-25T00:25:55Z

‎Commit your changes

2020-02-24T23:55:25Z

‎Create a Branch

2020-02-24T23:39:14Z

@@ Line 107: / Line 107: @@
 <pre>
 git commit -a -m "Summary of the changes"
 </pre>
 === Omit CONTROL/control from commits ===
@@ Line 115: / Line 119: @@
 git checkout -- CONTROL/control
 </pre>
 == Create a Pull Request ==
 A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.

@@ Line 1: / Line 1: @@
 [https://en.wikipedia.org/wiki/Git Git] is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.
@@ Line 12: / Line 11: @@
 * git
 * pkgtools
 * A text editor, Joe, Nano, or Vim unless you are happy with the default Vi

@@ Line 43: / Line 43: @@
 git clone https://git.hpkg.tv/USERNAME/webif.git
 </pre>
-Change to our repository directory and add the master repository as another remote - this enables you to pick up changes made to the master
+Change to your repository directory and add the master repository as another remote - this enables you to pick up changes made to the master
 <pre>
 cd /mod/git/webif

@@ Line 33: / Line 33: @@
 == Fork and clone reposiory ==
 Sign in and find the package you want to work with on the host repository eg https://git.hpkg.tv/hummypkg/webif
-If the package you are interested in is not visible in the repository contact the package owner to discuss access.
 Click on the Fork button (top right) and create a forked repository
@@ Line 50: / Line 51: @@
 # origin which points to your fork of the project. You can read and write to this remote.
 # upstream which points to the main project’s repository. You can only read from this remote.
 == Sync with master ==
 You don't need this step if you have just forked and cloned the master, but if time has elapsed and master may have changed you can pull in the latest changes and push them up to your host repository

@@ Line 2: / Line 2: @@
 [https://en.wikipedia.org/wiki/Git Git] is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.
 Some, but not all, packages developed for the Humax use Git to maintain the associated source code.  This allows for better tracking and control of changes and, potentially, allows for multiple users to collaborate on maintaining the package by making and testing changes on a private copy of the package and then submitting them for review and incorporation into the main package for distribution to the Humax community via the normal package update mechanism.
 This wiki page attempts to describe the basics required to submit a change to a package that you don't own using the ''webif'' package as an example.  It was written by a naive new user of Git and does not attempt to cover all of Git / Github and may contain errors, please correct and update this page where needed!
@@ Line 32: / Line 32: @@
 </pre>
 == Fork and clone reposiory ==
 Sign in and find the package you want to work with on the host repository eg https://git.hpkg.tv/hummypkg/webif
 Click on the Fork button (top right) and create a forked repository
 (using a fork creates a private copy and insulates your changes from those on the master, it is not needed if you are the repository owner)

@@ Line 62: / Line 62: @@
 cd /mod/git/webif
 git checkout -b FixBrowseTypo
 </pre>
 The -b flag is only needed for a new branch, not when switching to existing branch

@@ Line 83: / Line 83: @@
 Before committing Git needs to know which of the changes you have made in the repository folder are to be included in the commit, this is known as staging and can be done in several ways.
 == Create a Pull Request ==
 A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.
@@ Line 88: / Line 115: @@
 Ensure you specify the master branch of the master repository as the target for merge into and your branch to pull from
-[[File:PullRequest.png|frameless|Creating a Pull Request]]
+[[File:PullRequest.png|frame|centre|Creating a Pull Request]]
 The title and description of the Pull Request should explain to the package owner why your changes should be included in the package.

@@ Line 79: / Line 79: @@
 Test to ensure your changes are working as intended.
 == Commit your changes ==
 == Create a Pull Request ==
 A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.

@@ Line 57: / Line 57: @@
 </pre>
 == Create a Branch ==
-Every related set of changes should be in its own branch, don't try an fix unrelated problems in the same branch.
+Every related set of changes should be in its own branch, don't try and fix unrelated problems in the same branch.
 Branch names should be meaningful.
 <pre>
@@ Line 64: / Line 64: @@
 </pre>
 The -b flag is only needed for a new branch, not when switching to existing branch
 == Make your updates ==
 Using your favourite text editor make the necessary changes to the code.

@@ Line 80: / Line 80: @@
 == Create a Pull Request ==
 A ''Pull Request'' is a request to the package owner to merge your changes into the Master repository and update the Humax package.
-The New Pull Request button appears in a number of places on the remote repository pages under the Branches or Pull Requests tabs
+The New Pull Request button appears in a number of places on the remote repository pages under the Branches or Pull Requests tabs.
 Ensure you specify the master branch of the master repository as the target for merge into and your branch to pull from
 [[File:PullRequest.png|frameless|Creating a Pull Request]]
 The title and description of the Pull Request should explain to the package owner why your changes should be included in the package.
 Assign the request to the owner in the assignee tab (on the right of the page)
 The owner will review your changes and may request changes which should be made and committed on the same branch (a new Pull request is '''not''' needed)
 When happy with the changes the owner will merge the branch into master and close the Pull Request, the branch can be deleted and you can start again at [[Sync with master]] step
 == Further Information ==
-This page only scratches the surface of Git and there are numerous tutorials
+This page only scratches the surface of Git and there are numerous reference works and tutorials on github and elsewhere on the web.  A few links that have helped me are: