From ffd34ddc55da2c239d258ff38680cca96a5e134a Mon Sep 17 00:00:00 2001 From: Jonathan Holmgren Date: Sat, 28 May 2022 22:35:36 -0500 Subject: [PATCH] Updated ContributionGuidelines (markdown) --- ContributionGuidelines.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/ContributionGuidelines.md b/ContributionGuidelines.md index 92f8d52..cdd4345 100644 --- a/ContributionGuidelines.md +++ b/ContributionGuidelines.md @@ -19,3 +19,20 @@ Solve only one problem in each pull request. If you're fixing a bug and adding a If your patch fixes a bug, please be sure there is an [issue](https://github.com/PhoenixPE/PhoenixPE/issues) open for the bug before submitting a pull request. If your patch aims to improve performance or optimize a process, be sure to quantify your optimizations and document the trade-offs, and back up your claims with benchmarks and metrics. In order to maintain the quality and integrity of the **PhoenixPE** source tree, all pull requests must be reviewed before being merged. The [project lead](https://github.com/Homes32) has the ultimate authority in deciding whether to accept or reject a pull request. Do not be discouraged if your pull request is rejected! + +## Versioning + +### .Script Files + +Script files use semantic versioning in the form of `MAJOR.MINOR.PATCH.BUILD` eg. `1.0.2.0`. + +|Version|Description| +|---|---| +|MAJOR|Major change in feature, function, or API usage. Minor version and Patch version MUST be reset to 0 when Major version is incremented.| +|MINOR|New feature/functionality added. Patch version MUST be reset to 0 when Minor version is incremented.| +|PATCH|Bugfixes, download url updates, etc.| +|BUILD|Zero for release. May be incremented by the end user to track personal changes or for special builds.| + +### Public Project Releases + +The most current versions of individual scripts may be downloaded at any time from the master branch. Occasionally we will publish a release on github that bundles the current scripts with the PEBakery binaries. These released will be named by the date of the release in the form of `YYYY-MM-DD`. \ No newline at end of file