Workflow

GitHub Projects

Elephox framework uses GitHub Projects to plan future goals, manage issues and track progress of integrating interoperability.

Creating new issues

Issues are created using GitHub's issue system.

Every new issue should ideally have:

• a descriptive title
• a short description with links to references or specifications (for features)/reproduction code (for bugs) or whatever else helps others understand what the issues tries to address
• one or more labels to group it together with similar issues
• been assigned to a project (see GitHub Projects)

Releasing new versions

1. determine the new version type: major, minor, patch or preview
2. determine the new version name
   Scheme: x[.y[.z[-f]]]
x = major version
   y = minor version
   z = patch version
   f = flag (alpha1, beta1, RC1)
   major releases must increase the major version, reset all other versions to 0 and remove the flag
   minor releases must increase the minor version, keep the current major version, reset the patch version to 0 and remove the flag
   patch releases must increase the patch version and keep all other versions and remove the flag
   preview releases must increase at least one of the versions and the flag (alpha1 => alpha2 or beta1, beta1 => beta2 or RC1)
   Example version progressions:

1.0.1 --minor->   1.1.0        --patch->   1.1.1     --major-> 2.0.0
2.1.3 --preview-> 3.0.0-alpha1 --preview-> 3.0.0-RC1 --major-> 3.0.0 --patch-> 3.0.1

3. run phox release <type> <version> from the repository root