-
Notifications
You must be signed in to change notification settings - Fork 0
! FAQ
This is a starting point for programming projects that use Semantic Versioning.
It contains template documentation files for starting a project and Git Hooks + Github Action scripts and Github Apps that enforce a standardized development process with Semantic Versioning.
Semantic Versioning is a set of rules and grammar for version numbers and how they should be assigned and incremented.
The rules are designed around a numbering system that follows an X.Y.Z pattern with additional suffixes if needed. The X is the major version number, the Y is the minor version number and the Z is the patch version number. The rules define when these can be incremented and that the released package should not be modified without modifying the version number and releasing a new version.
See CONTRIBUTING.md for detailed instructions.
You can clone this repository and then use it as a template for your project by removing the initial remote and setting your own Github remote.
\- OR -
You can fork this repository to your Github Account and then use the `Use Template` feature when creating new repositories on Github.
Once you have the project initialized, follow the Quick Setup and Run Instructions in the README to make sure you update all of the pieces for your project.
You can use any programming language! This project is meant to be language agnostic, however I do recommend you look into Shell Scripting and Github Actions in order to understand how the script files work in this template.
The Git Hooks are script files that will be run on your local development machine. See the detailed instructions here. You will need to navigate to the .git/hooks directory in your local repository and create symbolic links to each hook script file with ln -s ../../scripts/hooks/<HOOK_NAME>.sh <HOOK_NAME
There are two types of Actions in this template: Semi-Automated and Fully Automated.
The Semi-Automated GitHub Actions will be available in your GitHub repository in the Repository header navigation bar under the Actions Tab. You will then need to trigger them automatically by selecting them in the menu panel on the left and then pressing the Run Workflow button.
The Fully Automated Actions should run when specific events occur such as PR creation or editing, pushing commits to PR branches, PR comments or on merge to main branch.
TBD
TBD