Any changes in this GitHub repository should be made by creating a new branch, committing and pushing changes, creating a pull request, and merging the pull request. Releases should be generated periodically along with the associated Docker containers.
Before making any changes, create a new branch. To make a new branch, enter the following on terminal,
git checkout -b {new-branch-name}Replace {new-branch-name} with something short that is self-descriptive. All changes should be made in this GitHub repository. Changes should be committed and pushed to the repository frequently.
Navigate to the branches page of this GitHub repository and click New pull request, found on the right side of the Your branches section. Revise the pull request title to be self-descriptive and copy the pull request template to the comment body. Fill out the pull request template and click Create pull request. Comment on the pull request as the pull request is reviewed and the pre-pull request check list is completed.
Upon completing review of a pull request and all items on the pre-pull request checklist are checked, click Squash and merge to merge the pull request. The branch can then be deleted.
Releases follow semantic versioning and should be created, at minimum, for every minor patch. Navigate to the releases page and click Draft new release. Enter the major, minor, and patch numbers delimited by periods as the tag number, such as 0.4.2. The release title should be Release {major}.{minor}.{patch}, such as Release 0.4.2. For the release description, follow the release template to describe the merged pull requests since the previous release.