elie/PhoenixPE
1
0
Fork 0
mirror of https://github.com/PhoenixPE/PhoenixPE.git synced 2025-09-18 02:58:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated ContributionGuidelines (markdown)

Jonathan Holmgren
2022-05-28 22:35:36 -05:00
parent ff48461cfd
commit ffd34ddc55
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
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. 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! 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`.