Download the PHP package pdga/data-objects without Composer
On this page you can find all versions of the php package pdga/data-objects. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pdga/data-objects
More information about pdga/data-objects
Files in pdga/data-objects
Package data-objects
Short Description Custom data object classes used by the PDGA.
License MIT
Homepage https://github.com/PDGA/php-data-objects
Informations about the package data-objects
php-data-objects
Data object related code for the PDGA's back-end PHP API systems.
Install Composer Dependencies
Run Unit Tests
Code Formatting Standards
Run PHP_CodeSniffer to see the existing styling issues.
Run the formatter to automatically fix the styling issues that can be fixed.
or
Require this Library as a Dependency in another Application
To add the package to an application's Composer dependencies, use the following Composer command:
You will also use the above command to update the package if it is already being used in your application but the major version number has been changed.
If you want to update an existing dependency on this package and only the minor or bug fix version has been changed you can use the following command in that application:
The above commands are very simple, however there are many options as far as dictating which versions are installed that can be used. For more information see the official Composer documentation.
Branching for features and bug fixes
When creating a new feature or bug fix, you will typically start by ensuring you are on the develop
branch and use the following
command to create your new branch:
If there is a Jira ticket for your task then using that ticket number and title is a good candidate for your branch name but as long as it is clear what your branch is for then you can use anything you wish.
Note that you do not always have to branch off of develop
, for instance if you are making a change to something that isn't merged
into develop
yet you will want to branch off of that other existing branch. It is important to remember which branch you branched
off of so that you merge back into that branch.
Once your changes are committed and pushed up, you are ready to make a Pull Request on GitHub. In your web browser, navigate to
https://github.com/PDGA/php-data-objects/pulls and click New Pull Request.
Ensure that the branch selected in the base
dropdown is the branch you branched off of, and the option selected in the compare
dropdown is your branch. Click Create Pull Request and add a description of your change in the Add a description
section.
Make sure you select at least two people as reviewers and then click Create Pull Request
below the description box
to open the Pull Request.
Merging a Pull Request
Once at least two people have approved your Pull Request it may be merged. There are two ways to do this:
You can either use the GUI on GitHub to automatically merge your branch into the branch you selected as base
and then subsequently delete your branch, or you can use the git
command line to do the same.
Using GitHub
The Merge pull request
button on GitHub is at the bottom of the main Pull Request page and once clicked it
will turn into a Delete Branch
button. After the branch is deleted you should change which branch you are working
in locally to the one you select as base
and run the following commands:
Using git command line
To use the git
command, first change your current working branch to your base
branch. Then use the following
command to merge your branch.
Once the merge is complete and any conflicts have been resolved and committed you must push up the base
branch.
NOTE: Changes can not be committed and pushed directly to develop
from the command line, so if your base
branch was
develop
please see the above instructions for using the GitHub GUI for merging.
At this point you can delete your branch from the origin:
After merging and deleting remotely
After deleting the branch from the origin, either manually or via GitHub, make sure to delete it locally:
Releasing a new version
To release a new version of the repository, all changes need to be merged into develop
via a Pull Request.
Changes can not be committed and pushed directly to develop
from the command line, so a Pull Request is required.
When you intend to release a new version you will also want to update the CHANGELOG.md
file with a list of changes
made under the new version number you intend to release (See below for information about version numbers).
Once all changes have been merged into develop
it needs to be merged into main
, again via a Pull Request.
Once everything is merged into main
a new tag can be created for the repository and pushed.
Creating a new tag
A new tag for the repository should be created using the following naming scheme: